home *** CD-ROM | disk | FTP | other *** search
/ Chip 2007 January, February, March & April / Chip-Cover-CD-2007-02.iso / Pakiet bezpieczenstwa / mini Pentoo LiveCD 2006.1 / mpentoo-2006.1.iso / livecd.squashfs / usr / include / ntfs / layout.h < prev    next >
C/C++ Source or Header  |  2005-10-18  |  103KB  |  2,485 lines
  1. /*
  2.  * layout.h - Ntfs on-disk layout structures.  Part of the Linux-NTFS project.
  3.  *
  4.  * Copyright (c) 2000-2005 Anton Altaparmakov
  5.  * Copyright (c)      2005 Yura Pakhuchiy
  6.  * Copyright (c)      2005 Yuval Fledel
  7.  *
  8.  * This program/include file is free software; you can redistribute it and/or
  9.  * modify it under the terms of the GNU General Public License as published
  10.  * by the Free Software Foundation; either version 2 of the License, or
  11.  * (at your option) any later version.
  12.  *
  13.  * This program/include file is distributed in the hope that it will be
  14.  * useful, but WITHOUT ANY WARRANTY; without even the implied warranty
  15.  * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16.  * GNU General Public License for more details.
  17.  *
  18.  * You should have received a copy of the GNU General Public License
  19.  * along with this program (in the main directory of the Linux-NTFS
  20.  * distribution in the file COPYING); if not, write to the Free Software
  21.  * Foundation,Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  22.  */
  23.  
  24. #ifndef _NTFS_LAYOUT_H
  25. #define _NTFS_LAYOUT_H
  26.  
  27. #include "types.h"
  28. #include "endians.h"
  29. #include "support.h"
  30.  
  31. /* The NTFS oem_id */
  32. #define magicNTFS    const_cpu_to_le64(0x202020205346544e)    /* "NTFS    " */
  33. #define NTFS_SB_MAGIC    0x5346544e                /* 'NTFS' */
  34.  
  35. /*
  36.  * Location of bootsector on partition:
  37.  *    The standard NTFS_BOOT_SECTOR is on sector 0 of the partition.
  38.  *    On NT4 and above there is one backup copy of the boot sector to
  39.  *    be found on the last sector of the partition (not normally accessible
  40.  *    from within Windows as the bootsector contained number of sectors
  41.  *    value is one less than the actual value!).
  42.  *    On versions of NT 3.51 and earlier, the backup copy was located at
  43.  *    number of sectors/2 (integer divide), i.e. in the middle of the volume.
  44.  */
  45.  
  46. /*
  47.  * BIOS parameter block (bpb) structure.
  48.  */
  49. typedef struct {
  50.     u16 bytes_per_sector;        /* Size of a sector in bytes. */
  51.     u8  sectors_per_cluster;    /* Size of a cluster in sectors. */
  52.     u16 reserved_sectors;        /* zero */
  53.     u8  fats;            /* zero */
  54.     u16 root_entries;        /* zero */
  55.     u16 sectors;            /* zero */
  56.     u8  media_type;            /* 0xf8 = hard disk */
  57.     u16 sectors_per_fat;        /* zero */
  58. /*0x0d*/u16 sectors_per_track;        /* Required to boot Windows. */
  59. /*0x0f*/u16 heads;            /* Required to boot Windows. */
  60. /*0x11*/u32 hidden_sectors;        /* Offset to the start of the partition
  61.                        relative to the disk in sectors.
  62.                        Required to boot Windows. */
  63. /*0x15*/u32 large_sectors;        /* zero */
  64. /* sizeof() = 25 (0x19) bytes */
  65. } __attribute__ ((__packed__)) BIOS_PARAMETER_BLOCK;
  66.  
  67. /*
  68.  * NTFS boot sector structure.
  69.  */
  70. typedef struct {
  71.     u8  jump[3];            /* Irrelevant (jump to boot up code).*/
  72.     u64 oem_id;            /* Magic "NTFS    ". */
  73. /*0x0b*/BIOS_PARAMETER_BLOCK bpb;    /* See BIOS_PARAMETER_BLOCK. */
  74.     u8  unused[4];            /* zero, NTFS diskedit.exe states that
  75.                        this is actually:
  76.                         u8 physical_drive;        // 0x80
  77.                         u8 current_head;        // zero
  78.                         u8 extended_boot_signature; // 0x80
  79.                         u8 unused;            // zero
  80.                      */
  81. /*0x28*/s64 number_of_sectors;        /* Number of sectors in volume. Gives
  82.                        maximum volume size of 2^63 sectors.
  83.                        Assuming standard sector size of 512
  84.                        bytes, the maximum byte size is
  85.                        approx. 4.7x10^21 bytes. (-; */
  86.     s64 mft_lcn;            /* Cluster location of mft data. */
  87.     s64 mftmirr_lcn;        /* Cluster location of copy of mft. */
  88.     s8  clusters_per_mft_record;    /* Mft record size in clusters. */
  89.     u8  reserved0[3];        /* zero */
  90.     s8  clusters_per_index_record;    /* Index block size in clusters. */
  91.     u8  reserved1[3];        /* zero */
  92.     u64 volume_serial_number;    /* Irrelevant (serial number). */
  93.     u32 checksum;            /* Boot sector checksum. */
  94. /*0x54*/u8  bootstrap[426];        /* Irrelevant (boot up code). */
  95.     u16 end_of_sector_marker;    /* End of bootsector magic. Always is
  96.                        0xaa55 in little endian. */
  97. /* sizeof() = 512 (0x200) bytes */
  98. } __attribute__ ((__packed__)) NTFS_BOOT_SECTOR;
  99.  
  100. /*
  101.  * Magic identifiers present at the beginning of all ntfs record containing
  102.  * records (like mft records for example).
  103.  */
  104. typedef enum {
  105.     /* Found in $MFT/$DATA. */
  106.     magic_FILE = const_cpu_to_le32(0x454c4946), /* Mft entry. */
  107.     magic_INDX = const_cpu_to_le32(0x58444e49), /* Index buffer. */
  108.     magic_HOLE = const_cpu_to_le32(0x454c4f48), /* ? (NTFS 3.0+?) */
  109.  
  110.     /* Found in $LogFile/$DATA. */
  111.     magic_RSTR = const_cpu_to_le32(0x52545352), /* Restart page. */
  112.     magic_RCRD = const_cpu_to_le32(0x44524352), /* Log record page. */
  113.  
  114.     /* Found in $LogFile/$DATA.  (May be found in $MFT/$DATA, also?) */
  115.     magic_CHKD = const_cpu_to_le32(0x444b4843), /* Modified by chkdsk. */
  116.  
  117.     /* Found in all ntfs record containing records. */
  118.     magic_BAAD = const_cpu_to_le32(0x44414142), /* Failed multi sector
  119.                                transfer was detected. */
  120.  
  121.     /*
  122.      * Found in $LogFile/$DATA when a page is full or 0xff bytes and is
  123.      * thus not initialized.  User has to initialize the page before using
  124.      * it.
  125.      */
  126.     magic_empty = const_cpu_to_le32(0xffffffff),/* Record is empty and has
  127.                                to be initialized before
  128.                                it can be used. */
  129. } NTFS_RECORD_TYPES;
  130.  
  131. /*
  132.  * Generic magic comparison macros. Finally found a use for the ## preprocessor
  133.  * operator! (-8
  134.  */
  135. #define ntfs_is_magic(x, m)    (   (u32)(x) == (u32)magic_##m )
  136. #define ntfs_is_magicp(p, m)    ( *(u32*)(p) == (u32)magic_##m )
  137.  
  138. /*
  139.  * Specialised magic comparison macros for the NTFS_RECORD_TYPES defined above.
  140.  */
  141. #define ntfs_is_file_record(x)    ( ntfs_is_magic (x, FILE) )
  142. #define ntfs_is_file_recordp(p)    ( ntfs_is_magicp(p, FILE) )
  143. #define ntfs_is_mft_record(x)    ( ntfs_is_file_record(x) )
  144. #define ntfs_is_mft_recordp(p)    ( ntfs_is_file_recordp(p) )
  145. #define ntfs_is_indx_record(x)    ( ntfs_is_magic (x, INDX) )
  146. #define ntfs_is_indx_recordp(p)    ( ntfs_is_magicp(p, INDX) )
  147. #define ntfs_is_hole_record(x)    ( ntfs_is_magic (x, HOLE) )
  148. #define ntfs_is_hole_recordp(p)    ( ntfs_is_magicp(p, HOLE) )
  149.  
  150. #define ntfs_is_rstr_record(x)    ( ntfs_is_magic (x, RSTR) )
  151. #define ntfs_is_rstr_recordp(p)    ( ntfs_is_magicp(p, RSTR) )
  152. #define ntfs_is_rcrd_record(x)    ( ntfs_is_magic (x, RCRD) )
  153. #define ntfs_is_rcrd_recordp(p)    ( ntfs_is_magicp(p, RCRD) )
  154.  
  155. #define ntfs_is_chkd_record(x)    ( ntfs_is_magic (x, CHKD) )
  156. #define ntfs_is_chkd_recordp(p)    ( ntfs_is_magicp(p, CHKD) )
  157.  
  158. #define ntfs_is_baad_record(x)    ( ntfs_is_magic (x, BAAD) )
  159. #define ntfs_is_baad_recordp(p)    ( ntfs_is_magicp(p, BAAD) )
  160.  
  161. #define ntfs_is_empty_record(x)        ( ntfs_is_magic (x, empty) )
  162. #define ntfs_is_empty_recordp(p)    ( ntfs_is_magicp(p, empty) )
  163.  
  164.  
  165. #define NTFS_BLOCK_SIZE        512
  166. #define NTFS_BLOCK_SIZE_BITS    9
  167.  
  168. /*
  169.  * The Update Sequence Array (usa) is an array of the u16 values which belong
  170.  * to the end of each sector protected by the update sequence record in which
  171.  * this array is contained. Note that the first entry is the Update Sequence
  172.  * Number (usn), a cyclic counter of how many times the protected record has
  173.  * been written to disk. The values 0 and -1 (ie. 0xffff) are not used. All
  174.  * last u16's of each sector have to be equal to the usn (during reading) or
  175.  * are set to it (during writing). If they are not, an incomplete multi sector
  176.  * transfer has occurred when the data was written.
  177.  * The maximum size for the update sequence array is fixed to:
  178.  *    maximum size = usa_ofs + (usa_count * 2) = 510 bytes
  179.  * The 510 bytes comes from the fact that the last u16 in the array has to
  180.  * (obviously) finish before the last u16 of the first 512-byte sector.
  181.  * This formula can be used as a consistency check in that usa_ofs +
  182.  * (usa_count * 2) has to be less than or equal to 510.
  183.  */
  184. typedef struct {
  185.     NTFS_RECORD_TYPES magic;/* A four-byte magic identifying the
  186.                    record type and/or status. */
  187.     u16 usa_ofs;        /* Offset to the Update Sequence Array (usa)
  188.                    from the start of the ntfs record. */
  189.     u16 usa_count;        /* Number of u16 sized entries in the usa
  190.                    including the Update Sequence Number (usn),
  191.                    thus the number of fixups is the usa_count
  192.                    minus 1. */
  193. } __attribute__ ((__packed__)) NTFS_RECORD;
  194.  
  195. /*
  196.  * System files mft record numbers. All these files are always marked as used
  197.  * in the bitmap attribute of the mft; presumably in order to avoid accidental
  198.  * allocation for random other mft records. Also, the sequence number for each
  199.  * of the system files is always equal to their mft record number and it is
  200.  * never modified.
  201.  */
  202. typedef enum {
  203.     FILE_MFT    = 0,    /* Master file table (mft). Data attribute
  204.                    contains the entries and bitmap attribute
  205.                    records which ones are in use (bit==1). */
  206.     FILE_MFTMirr    = 1,    /* Mft mirror: copy of first four mft records
  207.                    in data attribute. If cluster size > 4kiB,
  208.                    copy of first N mft records, with
  209.                     N = cluster_size / mft_record_size. */
  210.     FILE_LogFile    = 2,    /* Journalling log in data attribute. */
  211.     FILE_Volume    = 3,    /* Volume name attribute and volume information
  212.                    attribute (flags and ntfs version). Windows
  213.                    refers to this file as volume DASD (Direct
  214.                    Access Storage Device). */
  215.     FILE_AttrDef    = 4,    /* Array of attribute definitions in data
  216.                    attribute. */
  217.     FILE_root    = 5,    /* Root directory. */
  218.     FILE_Bitmap    = 6,    /* Allocation bitmap of all clusters (lcns) in
  219.                    data attribute. */
  220.     FILE_Boot    = 7,    /* Boot sector (always at cluster 0) in data
  221.                    attribute. */
  222.     FILE_BadClus    = 8,    /* Contains all bad clusters in the non-resident
  223.                    data attribute. */
  224.     FILE_Secure    = 9,    /* Shared security descriptors in data attribute
  225.                    and two indexes into the descriptors.
  226.                    Appeared in Windows 2000. Before that, this
  227.                    file was named $Quota but was unused. */
  228.     FILE_UpCase    = 10,    /* Uppercase equivalents of all 65536 Unicode
  229.                    characters in data attribute. */
  230.     FILE_Extend    = 11,    /* Directory containing other system files (eg.
  231.                    $ObjId, $Quota, $Reparse and $UsnJrnl). This
  232.                    is new to NTFS3.0. */
  233.     FILE_reserved12    = 12,    /* Reserved for future use (records 12-15). */
  234.     FILE_reserved13    = 13,
  235.     FILE_reserved14    = 14,
  236.     FILE_reserved15    = 15,
  237.     FILE_first_user    = 16,    /* First user file, used as test limit for
  238.                    whether to allow opening a file or not. */
  239. } NTFS_SYSTEM_FILES;
  240.  
  241. /*
  242.  * These are the so far known MFT_RECORD_* flags (16-bit) which contain
  243.  * information about the mft record in which they are present.
  244.  */
  245. typedef enum {
  246.     MFT_RECORD_IN_USE    = const_cpu_to_le16(0x0001),
  247.     MFT_RECORD_IS_DIRECTORY    = const_cpu_to_le16(0x0002),
  248.     MFT_REC_SPACE_FILLER    = 0xffff    /* Just to make flags 16-bit. */
  249. } __attribute__ ((__packed__)) MFT_RECORD_FLAGS;
  250.  
  251. /*
  252.  * mft references (aka file references or file record segment references) are
  253.  * used whenever a structure needs to refer to a record in the mft.
  254.  *
  255.  * A reference consists of a 48-bit index into the mft and a 16-bit sequence
  256.  * number used to detect stale references.
  257.  *
  258.  * For error reporting purposes we treat the 48-bit index as a signed quantity.
  259.  *
  260.  * The sequence number is a circular counter (skipping 0) describing how many
  261.  * times the referenced mft record has been (re)used. This has to match the
  262.  * sequence number of the mft record being referenced, otherwise the reference
  263.  * is considered stale and removed (FIXME: only ntfsck or the driver itself?).
  264.  *
  265.  * If the sequence number is zero it is assumed that no sequence number
  266.  * consistency checking should be performed.
  267.  *
  268.  * FIXME: Since inodes are 32-bit as of now, the driver needs to always check
  269.  * for high_part being 0 and if not either BUG(), cause a panic() or handle
  270.  * the situation in some other way. This shouldn't be a problem as a volume has
  271.  * to become HUGE in order to need more than 32-bits worth of mft records.
  272.  * Assuming the standard mft record size of 1kb only the records (never mind
  273.  * the non-resident attributes, etc.) would require 4Tb of space on their own
  274.  * for the first 32 bits worth of records. This is only if some strange person
  275.  * doesn't decide to foul play and make the mft sparse which would be a really
  276.  * horrible thing to do as it would trash our current driver implementation. )-:
  277.  * Do I hear screams "we want 64-bit inodes!" ?!? (-;
  278.  *
  279.  * FIXME: The mft zone is defined as the first 12% of the volume. This space is
  280.  * reserved so that the mft can grow contiguously and hence doesn't become
  281.  * fragmented. Volume free space includes the empty part of the mft zone and
  282.  * when the volume's free 88% are used up, the mft zone is shrunk by a factor
  283.  * of 2, thus making more space available for more files/data. This process is
  284.  * repeated every time there is no more free space except for the mft zone until
  285.  * there really is no more free space.
  286.  */
  287.  
  288. /*
  289.  * Typedef the MFT_REF as a 64-bit value for easier handling.
  290.  * Also define two unpacking macros to get to the reference (MREF) and
  291.  * sequence number (MSEQNO) respectively.
  292.  * The _LE versions are to be applied on little endian MFT_REFs.
  293.  * Note: The _LE versions will return a CPU endian formatted value!
  294.  */
  295. typedef enum {
  296.     MFT_REF_MASK_CPU    = 0x0000ffffffffffffULL,
  297.     MFT_REF_MASK_LE        = const_cpu_to_le64(0x0000ffffffffffffULL),
  298. } MFT_REF_CONSTS;
  299.  
  300. typedef u64 MFT_REF;
  301.  
  302. #define MK_MREF(m, s)    ((MFT_REF)(((MFT_REF)(s) << 48) |        \
  303.                     ((MFT_REF)(m) & MFT_REF_MASK_CPU)))
  304. #define MK_LE_MREF(m, s) const_cpu_to_le64(((MFT_REF)(((MFT_REF)(s) << 48) | \
  305.                     ((MFT_REF)(m) & MFT_REF_MASK_CPU))))
  306.  
  307. #define MREF(x)        ((u64)((x) & MFT_REF_MASK_CPU))
  308. #define MSEQNO(x)    ((u16)(((x) >> 48) & 0xffff))
  309. #define MREF_LE(x)    ((u64)(const_le64_to_cpu(x) & MFT_REF_MASK_CPU))
  310. #define MSEQNO_LE(x)    ((u16)((const_le64_to_cpu(x) >> 48) & 0xffff))
  311.  
  312. #define IS_ERR_MREF(x)    (((x) & 0x0000800000000000ULL) ? 1 : 0)
  313. #define ERR_MREF(x)    ((u64)((s64)(x)))
  314. #define MREF_ERR(x)    ((int)((s64)(x)))
  315.  
  316. /*
  317.  * The mft record header present at the beginning of every record in the mft.
  318.  * This is followed by a sequence of variable length attribute records which
  319.  * is terminated by an attribute of type AT_END which is a truncated attribute
  320.  * in that it only consists of the attribute type code AT_END and none of the
  321.  * other members of the attribute structure are present.
  322.  */
  323. typedef struct {
  324. /*Ofs*/
  325. /*  0    NTFS_RECORD; -- Unfolded here as gcc doesn't like unnamed structs. */
  326.     NTFS_RECORD_TYPES magic;/* Usually the magic is "FILE". */
  327.     u16 usa_ofs;        /* See NTFS_RECORD definition above. */
  328.     u16 usa_count;        /* See NTFS_RECORD definition above. */
  329.  
  330. /*  8*/    LSN lsn;        /* $LogFile sequence number for this record.
  331.                    Changed every time the record is modified. */
  332. /* 16*/    u16 sequence_number;    /* Number of times this mft record has been
  333.                    reused. (See description for MFT_REF
  334.                    above.) NOTE: The increment (skipping zero)
  335.                    is done when the file is deleted. NOTE: If
  336.                    this is zero it is left zero. */
  337. /* 18*/    u16 link_count;        /* Number of hard links, i.e. the number of
  338.                    directory entries referencing this record.
  339.                    NOTE: Only used in mft base records.
  340.                    NOTE: When deleting a directory entry we
  341.                    check the link_count and if it is 1 we
  342.                    delete the file. Otherwise we delete the
  343.                    FILE_NAME_ATTR being referenced by the
  344.                    directory entry from the mft record and
  345.                    decrement the link_count.
  346.                    FIXME: Careful with Win32 + DOS names! */
  347. /* 20*/    u16 attrs_offset;    /* Byte offset to the first attribute in this
  348.                    mft record from the start of the mft record.
  349.                    NOTE: Must be aligned to 8-byte boundary. */
  350. /* 22*/    MFT_RECORD_FLAGS flags;    /* Bit array of MFT_RECORD_FLAGS. When a file
  351.                    is deleted, the MFT_RECORD_IN_USE flag is
  352.                    set to zero. */
  353. /* 24*/    u32 bytes_in_use;    /* Number of bytes used in this mft record.
  354.                    NOTE: Must be aligned to 8-byte boundary. */
  355. /* 28*/    u32 bytes_allocated;    /* Number of bytes allocated for this mft
  356.                    record. This should be equal to the mft
  357.                    record size. */
  358. /* 32*/    MFT_REF base_mft_record; /* This is zero for base mft records.
  359.                    When it is not zero it is a mft reference
  360.                    pointing to the base mft record to which
  361.                    this record belongs (this is then used to
  362.                    locate the attribute list attribute present
  363.                    in the base record which describes this
  364.                    extension record and hence might need
  365.                    modification when the extension record
  366.                    itself is modified, also locating the
  367.                    attribute list also means finding the other
  368.                    potential extents, belonging to the non-base
  369.                    mft record). */
  370. /* 40*/    u16 next_attr_instance; /* The instance number that will be
  371.                    assigned to the next attribute added to this
  372.                    mft record. NOTE: Incremented each time
  373.                    after it is used. NOTE: Every time the mft
  374.                    record is reused this number is set to zero.
  375.                    NOTE: The first instance number is always 0.
  376.                  */
  377. /* The below fields are specific to NTFS 3.1+ (Windows XP and above): */
  378. /* 42*/ u16 reserved;        /* Reserved/alignment. */
  379. /* 44*/ u32 mft_record_number;    /* Number of this mft record. */
  380. /* sizeof() = 48 bytes */
  381. /*
  382.  * When (re)using the mft record, we place the update sequence array at this
  383.  * offset, i.e. before we start with the attributes. This also makes sense,
  384.  * otherwise we could run into problems with the update sequence array
  385.  * containing in itself the last two bytes of a sector which would mean that
  386.  * multi sector transfer protection wouldn't work. As you can't protect data
  387.  * by overwriting it since you then can't get it back...
  388.  * When reading we obviously use the data from the ntfs record header.
  389.  */
  390. } __attribute__ ((__packed__)) MFT_RECORD;
  391.  
  392. /* This is the version without the NTFS 3.1+ specific fields. */
  393. typedef struct {
  394. /*Ofs*/
  395. /*  0    NTFS_RECORD; -- Unfolded here as gcc doesn't like unnamed structs. */
  396.     NTFS_RECORD_TYPES magic;/* Usually the magic is "FILE". */
  397.     u16 usa_ofs;        /* See NTFS_RECORD definition above. */
  398.     u16 usa_count;        /* See NTFS_RECORD definition above. */
  399.  
  400. /*  8*/    LSN lsn;        /* $LogFile sequence number for this record.
  401.                    Changed every time the record is modified. */
  402. /* 16*/    u16 sequence_number;    /* Number of times this mft record has been
  403.                    reused. (See description for MFT_REF
  404.                    above.) NOTE: The increment (skipping zero)
  405.                    is done when the file is deleted. NOTE: If
  406.                    this is zero it is left zero. */
  407. /* 18*/    u16 link_count;        /* Number of hard links, i.e. the number of
  408.                    directory entries referencing this record.
  409.                    NOTE: Only used in mft base records.
  410.                    NOTE: When deleting a directory entry we
  411.                    check the link_count and if it is 1 we
  412.                    delete the file. Otherwise we delete the
  413.                    FILE_NAME_ATTR being referenced by the
  414.                    directory entry from the mft record and
  415.                    decrement the link_count.
  416.                    FIXME: Careful with Win32 + DOS names! */
  417. /* 20*/    u16 attrs_offset;    /* Byte offset to the first attribute in this
  418.                    mft record from the start of the mft record.
  419.                    NOTE: Must be aligned to 8-byte boundary. */
  420. /* 22*/    MFT_RECORD_FLAGS flags;    /* Bit array of MFT_RECORD_FLAGS. When a file
  421.                    is deleted, the MFT_RECORD_IN_USE flag is
  422.                    set to zero. */
  423. /* 24*/    u32 bytes_in_use;    /* Number of bytes used in this mft record.
  424.                    NOTE: Must be aligned to 8-byte boundary. */
  425. /* 28*/    u32 bytes_allocated;    /* Number of bytes allocated for this mft
  426.                    record. This should be equal to the mft
  427.                    record size. */
  428. /* 32*/    MFT_REF base_mft_record; /* This is zero for base mft records.
  429.                    When it is not zero it is a mft reference
  430.                    pointing to the base mft record to which
  431.                    this record belongs (this is then used to
  432.                    locate the attribute list attribute present
  433.                    in the base record which describes this
  434.                    extension record and hence might need
  435.                    modification when the extension record
  436.                    itself is modified, also locating the
  437.                    attribute list also means finding the other
  438.                    potential extents, belonging to the non-base
  439.                    mft record). */
  440. /* 40*/    u16 next_attr_instance; /* The instance number that will be
  441.                    assigned to the next attribute added to this
  442.                    mft record. NOTE: Incremented each time
  443.                    after it is used. NOTE: Every time the mft
  444.                    record is reused this number is set to zero.
  445.                    NOTE: The first instance number is always 0.
  446.                  */
  447. /* sizeof() = 42 bytes */
  448. /*
  449.  * When (re)using the mft record, we place the update sequence array at this
  450.  * offset, i.e. before we start with the attributes. This also makes sense,
  451.  * otherwise we could run into problems with the update sequence array
  452.  * containing in itself the last two bytes of a sector which would mean that
  453.  * multi sector transfer protection wouldn't work. As you can't protect data
  454.  * by overwriting it since you then can't get it back...
  455.  * When reading we obviously use the data from the ntfs record header.
  456.  */
  457. } __attribute__ ((__packed__)) MFT_RECORD_OLD;
  458.  
  459. /*
  460.  * System defined attributes (32-bit). Each attribute type has a corresponding
  461.  * attribute name (Unicode string of maximum 64 character length) as described
  462.  * by the attribute definitions present in the data attribute of the $AttrDef
  463.  * system file. On NTFS 3.0 volumes the names are just as the types are named
  464.  * in the below enum exchanging AT_ for the dollar sign ($). If that isn't a
  465.  * revealing choice of symbol... (-;
  466.  */
  467. typedef enum {
  468.     AT_UNUSED            = const_cpu_to_le32(         0),
  469.     AT_STANDARD_INFORMATION        = const_cpu_to_le32(      0x10),
  470.     AT_ATTRIBUTE_LIST        = const_cpu_to_le32(      0x20),
  471.     AT_FILE_NAME            = const_cpu_to_le32(      0x30),
  472.     AT_OBJECT_ID            = const_cpu_to_le32(      0x40),
  473.     AT_SECURITY_DESCRIPTOR        = const_cpu_to_le32(      0x50),
  474.     AT_VOLUME_NAME            = const_cpu_to_le32(      0x60),
  475.     AT_VOLUME_INFORMATION        = const_cpu_to_le32(      0x70),
  476.     AT_DATA                = const_cpu_to_le32(      0x80),
  477.     AT_INDEX_ROOT            = const_cpu_to_le32(      0x90),
  478.     AT_INDEX_ALLOCATION        = const_cpu_to_le32(      0xa0),
  479.     AT_BITMAP            = const_cpu_to_le32(      0xb0),
  480.     AT_REPARSE_POINT        = const_cpu_to_le32(      0xc0),
  481.     AT_EA_INFORMATION        = const_cpu_to_le32(      0xd0),
  482.     AT_EA                = const_cpu_to_le32(      0xe0),
  483.     AT_PROPERTY_SET            = const_cpu_to_le32(      0xf0),
  484.     AT_LOGGED_UTILITY_STREAM    = const_cpu_to_le32(     0x100),
  485.     AT_FIRST_USER_DEFINED_ATTRIBUTE    = const_cpu_to_le32(    0x1000),
  486.     AT_END                = const_cpu_to_le32(0xffffffff),
  487. } ATTR_TYPES;
  488.  
  489. /*
  490.  * The collation rules for sorting views/indexes/etc (32-bit).
  491.  *
  492.  * COLLATION_UNICODE_STRING - Collate Unicode strings by comparing their binary
  493.  *    Unicode values, except that when a character can be uppercased, the
  494.  *    upper case value collates before the lower case one.
  495.  * COLLATION_FILE_NAME - Collate file names as Unicode strings. The collation
  496.  *    is done very much like COLLATION_UNICODE_STRING. In fact I have no idea
  497.  *    what the difference is. Perhaps the difference is that file names
  498.  *    would treat some special characters in an odd way (see
  499.  *    unistr.c::ntfs_collate_names() and unistr.c::legal_ansi_char_array[]
  500.  *    for what I mean but COLLATION_UNICODE_STRING would not give any special
  501.  *    treatment to any characters at all, but this is speculation.
  502.  * COLLATION_NTOFS_ULONG - Sorting is done according to ascending u32    key
  503.  *    values. E.g. used for $SII index in FILE_Secure, which sorts by
  504.  *    security_id (u32).
  505.  * COLLATION_NTOFS_SID - Sorting is done according to ascending SID values.
  506.  *    E.g. used for $O index in FILE_Extend/$Quota.
  507.  * COLLATION_NTOFS_SECURITY_HASH - Sorting is done first by ascending hash
  508.  *    values and second by ascending security_id values. E.g. used for $SDH
  509.  *    index in FILE_Secure.
  510.  * COLLATION_NTOFS_ULONGS - Sorting is done according to a sequence of ascending
  511.  *    u32 key values. E.g. used for $O index in FILE_Extend/$ObjId, which
  512.  *    sorts by object_id (16-byte), by splitting up the object_id in four
  513.  *    u32 values and using them as individual keys. E.g. take the following
  514.  *    two security_ids, stored as follows on disk:
  515.  *        1st: a1 61 65 b7 65 7b d4 11 9e 3d 00 e0 81 10 42 59
  516.  *        2nd: 38 14 37 d2 d2 f3 d4 11 a5 21 c8 6b 79 b1 97 45
  517.  *    To compare them, they are split into four u32 values each, like so:
  518.  *        1st: 0xb76561a1 0x11d47b65 0xe0003d9e 0x59421081
  519.  *        2nd: 0xd2371438 0x11d4f3d2 0x6bc821a5 0x4597b179
  520.  *    Now, it is apparent why the 2nd object_id collates after the 1st: the
  521.  *    first u32 value of the 1st object_id is less than the first u32 of
  522.  *    the 2nd object_id. If the first u32 values of both object_ids were
  523.  *    equal then the second u32 values would be compared, etc.
  524.  */
  525. typedef enum {
  526.     COLLATION_BINARY     = const_cpu_to_le32(0), /* Collate by binary
  527.                     compare where the first byte is most
  528.                     significant. */
  529.     COLLATION_FILE_NAME     = const_cpu_to_le32(1), /* Collate file names
  530.                     as Unicode strings. */
  531.     COLLATION_UNICODE_STRING = const_cpu_to_le32(2), /* Collate Unicode
  532.                     strings by comparing their binary
  533.                     Unicode values, except that when a
  534.                     character can be uppercased, the upper
  535.                     case value collates before the lower
  536.                     case one. */
  537.     COLLATION_NTOFS_ULONG        = const_cpu_to_le32(16),
  538.     COLLATION_NTOFS_SID        = const_cpu_to_le32(17),
  539.     COLLATION_NTOFS_SECURITY_HASH    = const_cpu_to_le32(18),
  540.     COLLATION_NTOFS_ULONGS        = const_cpu_to_le32(19),
  541. } COLLATION_RULES;
  542.  
  543. /*
  544.  * The flags (32-bit) describing attribute properties in the attribute
  545.  * definition structure.  FIXME: This information is based on Regis's
  546.  * information and, according to him, it is not certain and probably
  547.  * incomplete.  The INDEXABLE flag is fairly certainly correct as only the file
  548.  * name attribute has this flag set and this is the only attribute indexed in
  549.  * NT4.
  550.  */
  551. typedef enum {
  552.     ATTR_DEF_INDEXABLE    = const_cpu_to_le32(0x02), /* Attribute can be
  553.                     indexed. */
  554.     ATTR_DEF_MULTIPLE    = const_cpu_to_le32(0x04), /* Attribute type
  555.                     can be present multiple times in the
  556.                     mft records of an inode. */
  557.     ATTR_DEF_NOT_ZERO    = const_cpu_to_le32(0x08), /* Attribute value
  558.                     must contain at least one non-zero
  559.                     byte. */
  560.     ATTR_DEF_INDEXED_UNIQUE    = const_cpu_to_le32(0x10), /* Attribute must be
  561.                     indexed and the attribute value must be
  562.                     unique for the attribute type in all of
  563.                     the mft records of an inode. */
  564.     ATTR_DEF_NAMED_UNIQUE    = const_cpu_to_le32(0x20), /* Attribute must be
  565.                     named and the name must be unique for
  566.                     the attribute type in all of the mft
  567.                     records of an inode. */
  568.     ATTR_DEF_RESIDENT    = const_cpu_to_le32(0x40), /* Attribute must be
  569.                     resident. */
  570.     ATTR_DEF_ALWAYS_LOG    = const_cpu_to_le32(0x80), /* Always log
  571.                     modifications to this attribute,
  572.                     regardless of whether it is resident or
  573.                     non-resident.  Without this, only log
  574.                     modifications if the attribute is
  575.                     resident. */
  576. } ATTR_DEF_FLAGS;
  577.  
  578. /*
  579.  * The data attribute of FILE_AttrDef contains a sequence of attribute
  580.  * definitions for the NTFS volume. With this, it is supposed to be safe for an
  581.  * older NTFS driver to mount a volume containing a newer NTFS version without
  582.  * damaging it (that's the theory. In practice it's: not damaging it too much).
  583.  * Entries are sorted by attribute type. The flags describe whether the
  584.  * attribute can be resident/non-resident and possibly other things, but the
  585.  * actual bits are unknown.
  586.  */
  587. typedef struct {
  588. /*hex ofs*/
  589. /*  0*/    ntfschar name[0x40];        /* Unicode name of the attribute. Zero
  590.                        terminated. */
  591. /* 80*/    ATTR_TYPES type;        /* Type of the attribute. */
  592. /* 84*/    u32 display_rule;        /* Default display rule.
  593.                        FIXME: What does it mean? (AIA) */
  594. /* 88*/ COLLATION_RULES collation_rule;    /* Default collation rule. */
  595. /* 8c*/    ATTR_DEF_FLAGS flags;        /* Flags describing the attribute. */
  596. /* 90*/    s64 min_size;            /* Optional minimum attribute size. */
  597. /* 98*/    s64 max_size;            /* Maximum size of attribute. */
  598. /* sizeof() = 0xa0 or 160 bytes */
  599. } __attribute__ ((__packed__)) ATTR_DEF;
  600.  
  601. /*
  602.  * Attribute flags (16-bit).
  603.  */
  604. typedef enum {
  605.     ATTR_IS_COMPRESSED    = const_cpu_to_le16(0x0001),
  606.     ATTR_COMPRESSION_MASK    = const_cpu_to_le16(0x00ff),  /* Compression
  607.                         method mask. Also, first
  608.                         illegal value. */
  609.     ATTR_IS_ENCRYPTED    = const_cpu_to_le16(0x4000),
  610.     ATTR_IS_SPARSE        = const_cpu_to_le16(0x8000),
  611. } __attribute__ ((__packed__)) ATTR_FLAGS;
  612.  
  613. /*
  614.  * Attribute compression.
  615.  *
  616.  * Only the data attribute is ever compressed in the current ntfs driver in
  617.  * Windows. Further, compression is only applied when the data attribute is
  618.  * non-resident. Finally, to use compression, the maximum allowed cluster size
  619.  * on a volume is 4kib.
  620.  *
  621.  * The compression method is based on independently compressing blocks of X
  622.  * clusters, where X is determined from the compression_unit value found in the
  623.  * non-resident attribute record header (more precisely: X = 2^compression_unit
  624.  * clusters). On Windows NT/2k, X always is 16 clusters (compression_unit = 4).
  625.  *
  626.  * There are three different cases of how a compression block of X clusters
  627.  * can be stored:
  628.  *
  629.  *   1) The data in the block is all zero (a sparse block):
  630.  *      This is stored as a sparse block in the runlist, i.e. the runlist
  631.  *      entry has length = X and lcn = -1. The mapping pairs array actually
  632.  *      uses a delta_lcn value length of 0, i.e. delta_lcn is not present at
  633.  *      all, which is then interpreted by the driver as lcn = -1.
  634.  *      NOTE: Even uncompressed files can be sparse on NTFS 3.0 volumes, then
  635.  *      the same principles apply as above, except that the length is not
  636.  *      restricted to being any particular value.
  637.  *
  638.  *   2) The data in the block is not compressed:
  639.  *      This happens when compression doesn't reduce the size of the block
  640.  *      in clusters. I.e. if compression has a small effect so that the
  641.  *      compressed data still occupies X clusters, then the uncompressed data
  642.  *      is stored in the block.
  643.  *      This case is recognised by the fact that the runlist entry has
  644.  *      length = X and lcn >= 0. The mapping pairs array stores this as
  645.  *      normal with a run length of X and some specific delta_lcn, i.e.
  646.  *      delta_lcn has to be present.
  647.  *
  648.  *   3) The data in the block is compressed:
  649.  *      The common case. This case is recognised by the fact that the run
  650.  *      list entry has length L < X and lcn >= 0. The mapping pairs array
  651.  *      stores this as normal with a run length of X and some specific
  652.  *      delta_lcn, i.e. delta_lcn has to be present. This runlist entry is
  653.  *      immediately followed by a sparse entry with length = X - L and
  654.  *      lcn = -1. The latter entry is to make up the vcn counting to the
  655.  *      full compression block size X.
  656.  *
  657.  * In fact, life is more complicated because adjacent entries of the same type
  658.  * can be coalesced. This means that one has to keep track of the number of
  659.  * clusters handled and work on a basis of X clusters at a time being one
  660.  * block. An example: if length L > X this means that this particular runlist
  661.  * entry contains a block of length X and part of one or more blocks of length
  662.  * L - X. Another example: if length L < X, this does not necessarily mean that
  663.  * the block is compressed as it might be that the lcn changes inside the block
  664.  * and hence the following runlist entry describes the continuation of the
  665.  * potentially compressed block. The block would be compressed if the
  666.  * following runlist entry describes at least X - L sparse clusters, thus
  667.  * making up the compression block length as described in point 3 above. (Of
  668.  * course, there can be several runlist entries with small lengths so that the
  669.  * sparse entry does not follow the first data containing entry with
  670.  * length < X.)
  671.  *
  672.  * NOTE: At the end of the compressed attribute value, there most likely is not
  673.  * just the right amount of data to make up a compression block, thus this data
  674.  * is not even attempted to be compressed. It is just stored as is, unless
  675.  * the number of clusters it occupies is reduced when compressed in which case
  676.  * it is stored as a compressed compression block, complete with sparse
  677.  * clusters at the end.
  678.  */
  679.  
  680. /*
  681.  * Flags of resident attributes (8-bit).
  682.  */
  683. typedef enum {
  684.     RESIDENT_ATTR_IS_INDEXED = 0x01, /* Attribute is referenced in an index
  685.                         (has implications for deleting and
  686.                         modifying the attribute). */
  687. } __attribute__ ((__packed__)) RESIDENT_ATTR_FLAGS;
  688.  
  689. /*
  690.  * Attribute record header. Always aligned to 8-byte boundary.
  691.  */
  692. typedef struct {
  693. /*Ofs*/
  694. /*  0*/    ATTR_TYPES type;    /* The (32-bit) type of the attribute. */
  695. /*  4*/    u32 length;        /* Byte size of the resident part of the
  696.                    attribute (aligned to 8-byte boundary).
  697.                    Used to get to the next attribute. */
  698. /*  8*/    u8 non_resident;    /* If 0, attribute is resident.
  699.                    If 1, attribute is non-resident. */
  700. /*  9*/    u8 name_length;        /* Unicode character size of name of attribute.
  701.                    0 if unnamed. */
  702. /* 10*/    u16 name_offset;    /* If name_length != 0, the byte offset to the
  703.                    beginning of the name from the attribute
  704.                    record. Note that the name is stored as a
  705.                    Unicode string. When creating, place offset
  706.                    just at the end of the record header. Then,
  707.                    follow with attribute value or mapping pairs
  708.                    array, resident and non-resident attributes
  709.                    respectively, aligning to an 8-byte
  710.                    boundary. */
  711. /* 12*/    ATTR_FLAGS flags;    /* Flags describing the attribute. */
  712. /* 14*/    u16 instance;        /* The instance of this attribute record. This
  713.                    number is unique within this mft record (see
  714.                    MFT_RECORD/next_attribute_instance notes
  715.                    above for more details). */
  716. /* 16*/    union {
  717.         /* Resident attributes. */
  718.         struct {
  719. /* 16 */        u32 value_length; /* Byte size of attribute value. */
  720. /* 20 */        u16 value_offset; /* Byte offset of the attribute
  721.                            value from the start of the
  722.                            attribute record. When creating,
  723.                            align to 8-byte boundary if we
  724.                            have a name present as this might
  725.                            not have a length of a multiple
  726.                            of 8-bytes. */
  727. /* 22 */        RESIDENT_ATTR_FLAGS resident_flags; /* See above. */
  728. /* 23 */        s8 reservedR;        /* Reserved/alignment to 8-byte
  729.                            boundary. */
  730. /* 24 */        void *resident_end[0]; /* Use offsetof(ATTR_RECORD,
  731.                           resident_end) to get size of
  732.                           a resident attribute. */
  733.         } __attribute__ ((__packed__));
  734.         /* Non-resident attributes. */
  735.         struct {
  736. /* 16*/            VCN lowest_vcn;    /* Lowest valid virtual cluster number
  737.                 for this portion of the attribute value or
  738.                 0 if this is the only extent (usually the
  739.                 case). - Only when an attribute list is used
  740.                 does lowest_vcn != 0 ever occur. */
  741. /* 24*/            VCN highest_vcn; /* Highest valid vcn of this extent of
  742.                 the attribute value. - Usually there is only one
  743.                 portion, so this usually equals the attribute
  744.                 value size in clusters minus 1. Can be -1 for
  745.                 zero length files. Can be 0 for "single extent"
  746.                 attributes. */
  747. /* 32*/            u16 mapping_pairs_offset; /* Byte offset from the
  748.                 beginning of the structure to the mapping pairs
  749.                 array which contains the mappings between the
  750.                 vcns and the logical cluster numbers (lcns).
  751.                 When creating, place this at the end of this
  752.                 record header aligned to 8-byte boundary. */
  753. /* 34*/            u8 compression_unit; /* The compression unit expressed
  754.                 as the log to the base 2 of the number of
  755.                 clusters in a compression unit. 0 means not
  756.                 compressed. (This effectively limits the
  757.                 compression unit size to be a power of two
  758.                 clusters.) WinNT4 only uses a value of 4. */
  759. /* 35*/            u8 reserved1[5];    /* Align to 8-byte boundary. */
  760. /* The sizes below are only used when lowest_vcn is zero, as otherwise it would
  761.    be difficult to keep them up-to-date.*/
  762. /* 40*/            s64 allocated_size;    /* Byte size of disk space
  763.                 allocated to hold the attribute value. Always
  764.                 is a multiple of the cluster size. When a file
  765.                 is compressed, this field is a multiple of the
  766.                 compression block size (2^compression_unit) and
  767.                 it represents the logically allocated space
  768.                 rather than the actual on disk usage. For this
  769.                 use the compressed_size (see below). */
  770. /* 48*/            s64 data_size;    /* Byte size of the attribute
  771.                 value. Can be larger than allocated_size if
  772.                 attribute value is compressed or sparse. */
  773. /* 56*/            s64 initialized_size;    /* Byte size of initialized
  774.                 portion of the attribute value. Usually equals
  775.                 data_size. */
  776. /* 64 */        void *non_resident_end[0]; /* Use offsetof(ATTR_RECORD,
  777.                               non_resident_end) to get
  778.                               size of a non resident
  779.                               attribute. */
  780. /* sizeof(uncompressed attr) = 64*/
  781. /* 64*/            s64 compressed_size;    /* Byte size of the attribute
  782.                 value after compression. Only present when
  783.                 compressed. Always is a multiple of the
  784.                 cluster size. Represents the actual amount of
  785.                 disk space being used on the disk. */
  786. /* 72 */        void *compressed_end[0];
  787.                 /* Use offsetof(ATTR_RECORD, compressed_end) to
  788.                    get size of a compressed attribute. */
  789. /* sizeof(compressed attr) = 72*/
  790.         } __attribute__ ((__packed__));
  791.     } __attribute__ ((__packed__));
  792. } __attribute__ ((__packed__)) ATTR_RECORD;
  793.  
  794. typedef ATTR_RECORD ATTR_REC;
  795.  
  796. /*
  797.  * File attribute flags (32-bit).
  798.  */
  799. typedef enum {
  800.     /*
  801.      * These flags are only present in the STANDARD_INFORMATION attribute
  802.      * (in the field file_attributes).
  803.      */
  804.     FILE_ATTR_READONLY        = const_cpu_to_le32(0x00000001),
  805.     FILE_ATTR_HIDDEN        = const_cpu_to_le32(0x00000002),
  806.     FILE_ATTR_SYSTEM        = const_cpu_to_le32(0x00000004),
  807.     /* Old DOS volid. Unused in NT.    = cpu_to_le32(0x00000008), */
  808.  
  809.     FILE_ATTR_DIRECTORY        = const_cpu_to_le32(0x00000010),
  810.     /* FILE_ATTR_DIRECTORY is not considered valid in NT. It is reserved
  811.        for the DOS SUBDIRECTORY flag. */
  812.     FILE_ATTR_ARCHIVE        = const_cpu_to_le32(0x00000020),
  813.     FILE_ATTR_DEVICE        = const_cpu_to_le32(0x00000040),
  814.     FILE_ATTR_NORMAL        = const_cpu_to_le32(0x00000080),
  815.  
  816.     FILE_ATTR_TEMPORARY        = const_cpu_to_le32(0x00000100),
  817.     FILE_ATTR_SPARSE_FILE        = const_cpu_to_le32(0x00000200),
  818.     FILE_ATTR_REPARSE_POINT        = const_cpu_to_le32(0x00000400),
  819.     FILE_ATTR_COMPRESSED        = const_cpu_to_le32(0x00000800),
  820.  
  821.     FILE_ATTR_OFFLINE        = const_cpu_to_le32(0x00001000),
  822.     FILE_ATTR_NOT_CONTENT_INDEXED    = const_cpu_to_le32(0x00002000),
  823.     FILE_ATTR_ENCRYPTED        = const_cpu_to_le32(0x00004000),
  824.  
  825.     FILE_ATTR_VALID_FLAGS        = const_cpu_to_le32(0x00007fb7),
  826.     /* FILE_ATTR_VALID_FLAGS masks out the old DOS VolId and the
  827.        FILE_ATTR_DEVICE and preserves everything else. This mask
  828.        is used to obtain all flags that are valid for reading. */
  829.     FILE_ATTR_VALID_SET_FLAGS    = const_cpu_to_le32(0x000031a7),
  830.     /* FILE_ATTR_VALID_SET_FLAGS masks out the old DOS VolId, the
  831.        F_A_DEVICE, F_A_DIRECTORY, F_A_SPARSE_FILE, F_A_REPARSE_POINT,
  832.        F_A_COMPRESSED and F_A_ENCRYPTED and preserves the rest. This mask
  833.        is used to to obtain all flags that are valid for setting. */
  834.  
  835.     /*
  836.      * These flags are only present in the FILE_NAME attribute (in the
  837.      * field file_attributes).
  838.      */
  839.     FILE_ATTR_DUP_FILE_NAME_INDEX_PRESENT    = const_cpu_to_le32(0x10000000),
  840.     /* This is a copy of the corresponding bit from the mft record, telling
  841.        us whether this is a directory or not, i.e. whether it has an
  842.        index root attribute or not. */
  843.     FILE_ATTR_DUP_VIEW_INDEX_PRESENT    = const_cpu_to_le32(0x20000000),
  844.     /* This is a copy of the corresponding bit from the mft record, telling
  845.        us whether this file has a view index present (eg. object id index,
  846.        quota index, one of the security indexes or the encrypting file
  847.        system related indexes). */
  848. } __attribute__ ((__packed__)) FILE_ATTR_FLAGS;
  849.  
  850. /*
  851.  * NOTE on times in NTFS: All times are in MS standard time format, i.e. they
  852.  * are the number of 100-nanosecond intervals since 1st January 1601, 00:00:00
  853.  * universal coordinated time (UTC). (In Linux time starts 1st January 1970,
  854.  * 00:00:00 UTC and is stored as the number of 1-second intervals since then.)
  855.  */
  856.  
  857. /*
  858.  * Attribute: Standard information (0x10).
  859.  *
  860.  * NOTE: Always resident.
  861.  * NOTE: Present in all base file records on a volume.
  862.  * NOTE: There is conflicting information about the meaning of each of the time
  863.  *     fields but the meaning as defined below has been verified to be
  864.  *     correct by practical experimentation on Windows NT4 SP6a and is hence
  865.  *     assumed to be the one and only correct interpretation.
  866.  */
  867. typedef struct {
  868. /*Ofs*/
  869. /*  0*/    s64 creation_time;        /* Time file was created. Updated when
  870.                        a filename is changed(?). */
  871. /*  8*/    s64 last_data_change_time;    /* Time the data attribute was last
  872.                        modified. */
  873. /* 16*/    s64 last_mft_change_time;    /* Time this mft record was last
  874.                        modified. */
  875. /* 24*/    s64 last_access_time;        /* Approximate time when the file was
  876.                        last accessed (obviously this is not
  877.                        updated on read-only volumes). In
  878.                        Windows this is only updated when
  879.                        accessed if some time delta has
  880.                        passed since the last update. Also,
  881.                        last access times updates can be
  882.                        disabled altogether for speed. */
  883. /* 32*/    FILE_ATTR_FLAGS file_attributes; /* Flags describing the file. */
  884. /* 36*/    union {
  885.         /* NTFS 1.2 (and previous, presumably) */
  886.         struct {
  887.         /* 36 */ u8 reserved12[12];    /* Reserved/alignment to 8-byte
  888.                            boundary. */
  889.         /* 48 */ void *v1_end[0];    /* Marker for offsetof(). */
  890.         } __attribute__ ((__packed__));
  891. /* sizeof() = 48 bytes */
  892.         /* NTFS 3.0 */
  893.         struct {
  894. /*
  895.  * If a volume has been upgraded from a previous NTFS version, then these
  896.  * fields are present only if the file has been accessed since the upgrade.
  897.  * Recognize the difference by comparing the length of the resident attribute
  898.  * value. If it is 48, then the following fields are missing. If it is 72 then
  899.  * the fields are present. Maybe just check like this:
  900.  *    if (resident.ValueLength < sizeof(STANDARD_INFORMATION)) {
  901.  *        Assume NTFS 1.2- format.
  902.  *        If (volume version is 3.0+)
  903.  *            Upgrade attribute to NTFS 3.0 format.
  904.  *        else
  905.  *            Use NTFS 1.2- format for access.
  906.  *    } else
  907.  *        Use NTFS 3.0 format for access.
  908.  * Only problem is that it might be legal to set the length of the value to
  909.  * arbitrarily large values thus spoiling this check. - But chkdsk probably
  910.  * views that as a corruption, assuming that it behaves like this for all
  911.  * attributes.
  912.  */
  913.         /* 36*/    u32 maximum_versions;    /* Maximum allowed versions for
  914.                 file. Zero if version numbering is disabled. */
  915.         /* 40*/    u32 version_number;    /* This file's version (if any).
  916.                 Set to zero if maximum_versions is zero. */
  917.         /* 44*/    u32 class_id;        /* Class id from bidirectional
  918.                 class id index (?). */
  919.         /* 48*/    u32 owner_id;        /* Owner_id of the user owning
  920.                 the file. Translate via $Q index in FILE_Extend
  921.                 /$Quota to the quota control entry for the user
  922.                 owning the file. Zero if quotas are disabled. */
  923.         /* 52*/    u32 security_id;    /* Security_id for the file.
  924.                 Translate via $SII index and $SDS data stream
  925.                 in FILE_Secure to the security descriptor. */
  926.         /* 56*/    u64 quota_charged;    /* Byte size of the charge to
  927.                 the quota for all streams of the file. Note: Is
  928.                 zero if quotas are disabled. */
  929.         /* 64*/    u64 usn;        /* Last update sequence number
  930.                 of the file. This is a direct index into the
  931.                 change (aka usn) journal file. It is zero if
  932.                 the usn journal is disabled.
  933.                 NOTE: To disable the journal need to delete
  934.                 the journal file itself and to then walk the
  935.                 whole mft and set all Usn entries in all mft
  936.                 records to zero! (This can take a while!)
  937.                 The journal is FILE_Extend/$UsnJrnl. Win2k
  938.                 will recreate the journal and initiate
  939.                 logging if necessary when mounting the
  940.                 partition. This, in contrast to disabling the
  941.                 journal is a very fast process, so the user
  942.                 won't even notice it. */
  943.         /* 72*/ void *v3_end[0]; /* Marker for offsetof(). */
  944.         } __attribute__ ((__packed__));
  945.     } __attribute__ ((__packed__));
  946. /* sizeof() = 72 bytes (NTFS 3.0) */
  947. } __attribute__ ((__packed__)) STANDARD_INFORMATION;
  948.  
  949. /*
  950.  * Attribute: Attribute list (0x20).
  951.  *
  952.  * - Can be either resident or non-resident.
  953.  * - Value consists of a sequence of variable length, 8-byte aligned,
  954.  * ATTR_LIST_ENTRY records.
  955.  * - The attribute list attribute contains one entry for each attribute of
  956.  * the file in which the list is located, except for the list attribute
  957.  * itself. The list is sorted: first by attribute type, second by attribute
  958.  * name (if present), third by instance number. The extents of one
  959.  * non-resident attribute (if present) immediately follow after the initial
  960.  * extent. They are ordered by lowest_vcn and have their instance set to zero.
  961.  * It is not allowed to have two attributes with all sorting keys equal.
  962.  * - Further restrictions:
  963.  *    - If not resident, the vcn to lcn mapping array has to fit inside the
  964.  *      base mft record.
  965.  *    - The attribute list attribute value has a maximum size of 256kb. This
  966.  *      is imposed by the Windows cache manager.
  967.  * - Attribute lists are only used when the attributes of mft record do not
  968.  * fit inside the mft record despite all attributes (that can be made
  969.  * non-resident) having been made non-resident. This can happen e.g. when:
  970.  *    - File has a large number of hard links (lots of file name
  971.  *      attributes present).
  972.  *    - The mapping pairs array of some non-resident attribute becomes so
  973.  *      large due to fragmentation that it overflows the mft record.
  974.  *    - The security descriptor is very complex (not applicable to
  975.  *      NTFS 3.0 volumes).
  976.  *    - There are many named streams.
  977.  */
  978. typedef struct {
  979. /*Ofs*/
  980. /*  0*/    ATTR_TYPES type;    /* Type of referenced attribute. */
  981. /*  4*/    u16 length;        /* Byte size of this entry. */
  982. /*  6*/    u8 name_length;        /* Size in Unicode chars of the name of the
  983.                    attribute or 0 if unnamed. */
  984. /*  7*/    u8 name_offset;        /* Byte offset to beginning of attribute name
  985.                    (always set this to where the name would
  986.                    start even if unnamed). */
  987. /*  8*/    VCN lowest_vcn;        /* Lowest virtual cluster number of this portion
  988.                    of the attribute value. This is usually 0. It
  989.                    is non-zero for the case where one attribute
  990.                    does not fit into one mft record and thus
  991.                    several mft records are allocated to hold
  992.                    this attribute. In the latter case, each mft
  993.                    record holds one extent of the attribute and
  994.                    there is one attribute list entry for each
  995.                    extent. NOTE: This is DEFINITELY a signed
  996.                    value! The windows driver uses cmp, followed
  997.                    by jg when comparing this, thus it treats it
  998.                    as signed. */
  999. /* 16*/    MFT_REF mft_reference;    /* The reference of the mft record holding
  1000.                    the ATTR_RECORD for this portion of the
  1001.                    attribute value. */
  1002. /* 24*/    u16 instance;        /* If lowest_vcn = 0, the instance of the
  1003.                    attribute being referenced; otherwise 0. */
  1004. /* 26*/    ntfschar name[0];    /* Use when creating only. When reading use
  1005.                    name_offset to determine the location of the
  1006.                    name. */
  1007. /* sizeof() = 26 + (attribute_name_length * 2) bytes */
  1008. } __attribute__ ((__packed__)) ATTR_LIST_ENTRY;
  1009.  
  1010. /*
  1011.  * The maximum allowed length for a file name.
  1012.  */
  1013. #define NTFS_MAX_NAME_LEN    255
  1014.  
  1015. /*
  1016.  * Possible namespaces for filenames in ntfs (8-bit).
  1017.  */
  1018. typedef enum {
  1019.     FILE_NAME_POSIX            = 0x00,
  1020.         /* This is the largest namespace. It is case sensitive and
  1021.            allows all Unicode characters except for: '\0' and '/'.
  1022.            Beware that in WinNT/2k files which eg have the same name
  1023.            except for their case will not be distinguished by the
  1024.            standard utilities and thus a "del filename" will delete
  1025.            both "filename" and "fileName" without warning. */
  1026.     FILE_NAME_WIN32            = 0x01,
  1027.         /* The standard WinNT/2k NTFS long filenames. Case insensitive.
  1028.            All Unicode chars except: '\0', '"', '*', '/', ':', '<',
  1029.            '>', '?', '\' and '|'. Further, names cannot end with a '.'
  1030.            or a space. */
  1031.     FILE_NAME_DOS            = 0x02,
  1032.         /* The standard DOS filenames (8.3 format). Uppercase only.
  1033.            All 8-bit characters greater space, except: '"', '*', '+',
  1034.            ',', '/', ':', ';', '<', '=', '>', '?' and '\'. */
  1035.     FILE_NAME_WIN32_AND_DOS        = 0x03,
  1036.         /* 3 means that both the Win32 and the DOS filenames are
  1037.            identical and hence have been saved in this single filename
  1038.            record. */
  1039. } __attribute__ ((__packed__)) FILE_NAME_TYPE_FLAGS;
  1040.  
  1041. /*
  1042.  * Attribute: Filename (0x30).
  1043.  *
  1044.  * NOTE: Always resident.
  1045.  * NOTE: All fields, except the parent_directory, are only updated when the
  1046.  *     filename is changed. Until then, they just become out of sync with
  1047.  *     reality and the more up to date values are present in the standard
  1048.  *     information attribute.
  1049.  * NOTE: There is conflicting information about the meaning of each of the time
  1050.  *     fields but the meaning as defined below has been verified to be
  1051.  *     correct by practical experimentation on Windows NT4 SP6a and is hence
  1052.  *     assumed to be the one and only correct interpretation.
  1053.  */
  1054. typedef struct {
  1055. /*hex ofs*/
  1056. /*  0*/    MFT_REF parent_directory;    /* Directory this filename is
  1057.                        referenced from. */
  1058. /*  8*/    s64 creation_time;        /* Time file was created. */
  1059. /* 10*/    s64 last_data_change_time;    /* Time the data attribute was last
  1060.                        modified. */
  1061. /* 18*/    s64 last_mft_change_time;    /* Time this mft record was last
  1062.                        modified. */
  1063. /* 20*/    s64 last_access_time;        /* Last time this mft record was
  1064.                        accessed. */
  1065. /* 28*/    s64 allocated_size;        /* Byte size of allocated space for the
  1066.                        data attribute. NOTE: Is a multiple
  1067.                        of the cluster size. */
  1068. /* 30*/    s64 data_size;            /* Byte size of actual data in data
  1069.                        attribute. */
  1070. /* 38*/    FILE_ATTR_FLAGS file_attributes;    /* Flags describing the file. */
  1071. /* 3c*/    union {
  1072.     /* 3c*/    struct {
  1073.         /* 3c*/    u16 packed_ea_size;    /* Size of the buffer needed to
  1074.                            pack the extended attributes
  1075.                            (EAs), if such are present.*/
  1076.         /* 3e*/    u16 reserved;        /* Reserved for alignment. */
  1077.         } __attribute__ ((__packed__));
  1078.     /* 3c*/    u32 reparse_point_tag;        /* Type of reparse point,
  1079.                            present only in reparse
  1080.                            points and only if there are
  1081.                            no EAs. */
  1082.     } __attribute__ ((__packed__));
  1083. /* 40*/    u8 file_name_length;            /* Length of file name in
  1084.                            (Unicode) characters. */
  1085. /* 41*/    FILE_NAME_TYPE_FLAGS file_name_type;    /* Namespace of the file name.*/
  1086. /* 42*/    ntfschar file_name[0];            /* File name in Unicode. */
  1087. } __attribute__ ((__packed__)) FILE_NAME_ATTR;
  1088.  
  1089. /*
  1090.  * GUID structures store globally unique identifiers (GUID). A GUID is a
  1091.  * 128-bit value consisting of one group of eight hexadecimal digits, followed
  1092.  * by three groups of four hexadecimal digits each, followed by one group of
  1093.  * twelve hexadecimal digits. GUIDs are Microsoft's implementation of the
  1094.  * distributed computing environment (DCE) universally unique identifier (UUID).
  1095.  * Example of a GUID:
  1096.  *    1F010768-5A73-BC91-0010-A52216A7
  1097.  */
  1098. typedef struct {
  1099.     u32 data1;    /* The first eight hexadecimal digits of the GUID. */
  1100.     u16 data2;    /* The first group of four hexadecimal digits. */
  1101.     u16 data3;    /* The second group of four hexadecimal digits. */
  1102.     u8 data4[8];    /* The first two bytes are the third group of four
  1103.                hexadecimal digits. The remaining six bytes are the
  1104.                final 12 hexadecimal digits. */
  1105. } __attribute__ ((__packed__)) GUID;
  1106.  
  1107. /*
  1108.  * FILE_Extend/$ObjId contains an index named $O. This index contains all
  1109.  * object_ids present on the volume as the index keys and the corresponding
  1110.  * mft_record numbers as the index entry data parts. The data part (defined
  1111.  * below) also contains three other object_ids:
  1112.  *    birth_volume_id - object_id of FILE_Volume on which the file was first
  1113.  *              created. Optional (i.e. can be zero).
  1114.  *    birth_object_id - object_id of file when it was first created. Usually
  1115.  *              equals the object_id. Optional (i.e. can be zero).
  1116.  *    domain_id    - Reserved (always zero).
  1117.  */
  1118. typedef struct {
  1119.     MFT_REF mft_reference;    /* Mft record containing the object_id in
  1120.                    the index entry key. */
  1121.     union {
  1122.         struct {
  1123.             GUID birth_volume_id;
  1124.             GUID birth_object_id;
  1125.             GUID domain_id;
  1126.         } __attribute__ ((__packed__));
  1127.         u8 extended_info[48];
  1128.     } __attribute__ ((__packed__));
  1129. } __attribute__ ((__packed__)) OBJ_ID_INDEX_DATA;
  1130.  
  1131. /*
  1132.  * Attribute: Object id (NTFS 3.0+) (0x40).
  1133.  *
  1134.  * NOTE: Always resident.
  1135.  */
  1136. typedef struct {
  1137.     GUID object_id;                /* Unique id assigned to the
  1138.                            file.*/
  1139.     /* The following fields are optional. The attribute value size is 16
  1140.        bytes, i.e. sizeof(GUID), if these are not present at all. Note,
  1141.        the entries can be present but one or more (or all) can be zero
  1142.        meaning that that particular value(s) is(are) not defined. Note,
  1143.        when the fields are missing here, it is well possible that they are
  1144.        to be found within the $Extend/$ObjId system file indexed under the
  1145.        above object_id. */
  1146.     union {
  1147.         struct {
  1148.             GUID birth_volume_id;    /* Unique id of volume on which
  1149.                            the file was first created.*/
  1150.             GUID birth_object_id;    /* Unique id of file when it was
  1151.                            first created. */
  1152.             GUID domain_id;        /* Reserved, zero. */
  1153.         } __attribute__ ((__packed__));
  1154.         u8 extended_info[48];
  1155.     } __attribute__ ((__packed__));
  1156. } __attribute__ ((__packed__)) OBJECT_ID_ATTR;
  1157.  
  1158. /*
  1159.  * The pre-defined IDENTIFIER_AUTHORITIES used as SID_IDENTIFIER_AUTHORITY in
  1160.  * the SID structure (see below).
  1161.  */
  1162. //typedef enum {                    /* SID string prefix. */
  1163. //    SECURITY_NULL_SID_AUTHORITY    = {0, 0, 0, 0, 0, 0},    /* S-1-0 */
  1164. //    SECURITY_WORLD_SID_AUTHORITY    = {0, 0, 0, 0, 0, 1},    /* S-1-1 */
  1165. //    SECURITY_LOCAL_SID_AUTHORITY    = {0, 0, 0, 0, 0, 2},    /* S-1-2 */
  1166. //    SECURITY_CREATOR_SID_AUTHORITY    = {0, 0, 0, 0, 0, 3},    /* S-1-3 */
  1167. //    SECURITY_NON_UNIQUE_AUTHORITY    = {0, 0, 0, 0, 0, 4},    /* S-1-4 */
  1168. //    SECURITY_NT_SID_AUTHORITY    = {0, 0, 0, 0, 0, 5},    /* S-1-5 */
  1169. //} IDENTIFIER_AUTHORITIES;
  1170.  
  1171. /*
  1172.  * These relative identifiers (RIDs) are used with the above identifier
  1173.  * authorities to make up universal well-known SIDs.
  1174.  *
  1175.  * Note: The relative identifier (RID) refers to the portion of a SID, which
  1176.  * identifies a user or group in relation to the authority that issued the SID.
  1177.  * For example, the universal well-known SID Creator Owner ID (S-1-3-0) is
  1178.  * made up of the identifier authority SECURITY_CREATOR_SID_AUTHORITY (3) and
  1179.  * the relative identifier SECURITY_CREATOR_OWNER_RID (0).
  1180.  */
  1181. typedef enum {                    /* Identifier authority. */
  1182.     SECURITY_NULL_RID          = 0,    /* S-1-0 */
  1183.     SECURITY_WORLD_RID          = 0,    /* S-1-1 */
  1184.     SECURITY_LOCAL_RID          = 0,    /* S-1-2 */
  1185.  
  1186.     SECURITY_CREATOR_OWNER_RID      = 0,    /* S-1-3 */
  1187.     SECURITY_CREATOR_GROUP_RID      = 1,    /* S-1-3 */
  1188.  
  1189.     SECURITY_CREATOR_OWNER_SERVER_RID = 2,    /* S-1-3 */
  1190.     SECURITY_CREATOR_GROUP_SERVER_RID = 3,    /* S-1-3 */
  1191.  
  1192.     SECURITY_DIALUP_RID          = 1,
  1193.     SECURITY_NETWORK_RID          = 2,
  1194.     SECURITY_BATCH_RID          = 3,
  1195.     SECURITY_INTERACTIVE_RID      = 4,
  1196.     SECURITY_SERVICE_RID          = 6,
  1197.     SECURITY_ANONYMOUS_LOGON_RID      = 7,
  1198.     SECURITY_PROXY_RID          = 8,
  1199.     SECURITY_ENTERPRISE_CONTROLLERS_RID=9,
  1200.     SECURITY_SERVER_LOGON_RID      = 9,
  1201.     SECURITY_PRINCIPAL_SELF_RID      = 0xa,
  1202.     SECURITY_AUTHENTICATED_USER_RID      = 0xb,
  1203.     SECURITY_RESTRICTED_CODE_RID      = 0xc,
  1204.     SECURITY_TERMINAL_SERVER_RID      = 0xd,
  1205.  
  1206.     SECURITY_LOGON_IDS_RID          = 5,
  1207.     SECURITY_LOGON_IDS_RID_COUNT      = 3,
  1208.  
  1209.     SECURITY_LOCAL_SYSTEM_RID      = 0x12,
  1210.  
  1211.     SECURITY_NT_NON_UNIQUE          = 0x15,
  1212.  
  1213.     SECURITY_BUILTIN_DOMAIN_RID      = 0x20,
  1214.  
  1215.     /*
  1216.      * Well-known domain relative sub-authority values (RIDs).
  1217.      */
  1218.  
  1219.     /* Users. */
  1220.     DOMAIN_USER_RID_ADMIN          = 0x1f4,
  1221.     DOMAIN_USER_RID_GUEST          = 0x1f5,
  1222.     DOMAIN_USER_RID_KRBTGT          = 0x1f6,
  1223.  
  1224.     /* Groups. */
  1225.     DOMAIN_GROUP_RID_ADMINS          = 0x200,
  1226.     DOMAIN_GROUP_RID_USERS          = 0x201,
  1227.     DOMAIN_GROUP_RID_GUESTS          = 0x202,
  1228.     DOMAIN_GROUP_RID_COMPUTERS      = 0x203,
  1229.     DOMAIN_GROUP_RID_CONTROLLERS      = 0x204,
  1230.     DOMAIN_GROUP_RID_CERT_ADMINS      = 0x205,
  1231.     DOMAIN_GROUP_RID_SCHEMA_ADMINS      = 0x206,
  1232.     DOMAIN_GROUP_RID_ENTERPRISE_ADMINS= 0x207,
  1233.     DOMAIN_GROUP_RID_POLICY_ADMINS      = 0x208,
  1234.  
  1235.     /* Aliases. */
  1236.     DOMAIN_ALIAS_RID_ADMINS          = 0x220,
  1237.     DOMAIN_ALIAS_RID_USERS          = 0x221,
  1238.     DOMAIN_ALIAS_RID_GUESTS          = 0x222,
  1239.     DOMAIN_ALIAS_RID_POWER_USERS      = 0x223,
  1240.  
  1241.     DOMAIN_ALIAS_RID_ACCOUNT_OPS      = 0x224,
  1242.     DOMAIN_ALIAS_RID_SYSTEM_OPS      = 0x225,
  1243.     DOMAIN_ALIAS_RID_PRINT_OPS      = 0x226,
  1244.     DOMAIN_ALIAS_RID_BACKUP_OPS      = 0x227,
  1245.  
  1246.     DOMAIN_ALIAS_RID_REPLICATOR      = 0x228,
  1247.     DOMAIN_ALIAS_RID_RAS_SERVERS      = 0x229,
  1248.     DOMAIN_ALIAS_RID_PREW2KCOMPACCESS = 0x22a,
  1249. } RELATIVE_IDENTIFIERS;
  1250.  
  1251. /*
  1252.  * The universal well-known SIDs:
  1253.  *
  1254.  *    NULL_SID            S-1-0-0
  1255.  *    WORLD_SID            S-1-1-0
  1256.  *    LOCAL_SID            S-1-2-0
  1257.  *    CREATOR_OWNER_SID        S-1-3-0
  1258.  *    CREATOR_GROUP_SID        S-1-3-1
  1259.  *    CREATOR_OWNER_SERVER_SID    S-1-3-2
  1260.  *    CREATOR_GROUP_SERVER_SID    S-1-3-3
  1261.  *
  1262.  *    (Non-unique IDs)        S-1-4
  1263.  *
  1264.  * NT well-known SIDs:
  1265.  *
  1266.  *    NT_AUTHORITY_SID    S-1-5
  1267.  *    DIALUP_SID        S-1-5-1
  1268.  *
  1269.  *    NETWORD_SID        S-1-5-2
  1270.  *    BATCH_SID        S-1-5-3
  1271.  *    INTERACTIVE_SID        S-1-5-4
  1272.  *    SERVICE_SID        S-1-5-6
  1273.  *    ANONYMOUS_LOGON_SID    S-1-5-7        (aka null logon session)
  1274.  *    PROXY_SID        S-1-5-8
  1275.  *    SERVER_LOGON_SID    S-1-5-9        (aka domain controller account)
  1276.  *    SELF_SID        S-1-5-10    (self RID)
  1277.  *    AUTHENTICATED_USER_SID    S-1-5-11
  1278.  *    RESTRICTED_CODE_SID    S-1-5-12    (running restricted code)
  1279.  *    TERMINAL_SERVER_SID    S-1-5-13    (running on terminal server)
  1280.  *
  1281.  *    (Logon IDs)        S-1-5-5-X-Y
  1282.  *
  1283.  *    (NT non-unique IDs)    S-1-5-0x15-...
  1284.  *
  1285.  *    (Built-in domain)    S-1-5-0x20
  1286.  */
  1287.  
  1288. /*
  1289.  * The SID_IDENTIFIER_AUTHORITY is a 48-bit value used in the SID structure.
  1290.  *
  1291.  * NOTE: This is stored as a big endian number.
  1292.  */
  1293. typedef union {
  1294.     struct {
  1295.         u16 high_part;        /* High 16-bits. */
  1296.         u32 low_part;        /* Low 32-bits. */
  1297.     } __attribute__ ((__packed__));
  1298.     u8 value[6];            /* Value as individual bytes. */
  1299. } __attribute__ ((__packed__)) SID_IDENTIFIER_AUTHORITY;
  1300.  
  1301. /*
  1302.  * The SID structure is a variable-length structure used to uniquely identify
  1303.  * users or groups. SID stands for security identifier.
  1304.  *
  1305.  * The standard textual representation of the SID is of the form:
  1306.  *    S-R-I-S-S...
  1307.  * Where:
  1308.  *    - The first "S" is the literal character 'S' identifying the following
  1309.  *    digits as a SID.
  1310.  *    - R is the revision level of the SID expressed as a sequence of digits
  1311.  *    in decimal.
  1312.  *    - I is the 48-bit identifier_authority, expressed as digits in decimal,
  1313.  *    if I < 2^32, or hexadecimal prefixed by "0x", if I >= 2^32.
  1314.  *    - S... is one or more sub_authority values, expressed as digits in
  1315.  *    decimal.
  1316.  *
  1317.  * Example SID; the domain-relative SID of the local Administrators group on
  1318.  * Windows NT/2k:
  1319.  *    S-1-5-32-544
  1320.  * This translates to a SID with:
  1321.  *    revision = 1,
  1322.  *    sub_authority_count = 2,
  1323.  *    identifier_authority = {0,0,0,0,0,5},    // SECURITY_NT_AUTHORITY
  1324.  *    sub_authority[0] = 32,            // SECURITY_BUILTIN_DOMAIN_RID
  1325.  *    sub_authority[1] = 544            // DOMAIN_ALIAS_RID_ADMINS
  1326.  */
  1327. typedef struct {
  1328.     u8 revision;
  1329.     u8 sub_authority_count;
  1330.     SID_IDENTIFIER_AUTHORITY identifier_authority;
  1331.     u32 sub_authority[1];        /* At least one sub_authority. */
  1332. } __attribute__ ((__packed__)) SID;
  1333.  
  1334. /*
  1335.  * Current constants for SIDs.
  1336.  */
  1337. typedef enum {
  1338.     SID_REVISION            =  1,    /* Current revision level. */
  1339.     SID_MAX_SUB_AUTHORITIES        = 15,    /* Maximum number of those. */
  1340.     SID_RECOMMENDED_SUB_AUTHORITIES    =  1,    /* Will change to around 6 in
  1341.                            a future revision. */
  1342. } SID_CONSTANTS;
  1343.  
  1344. /*
  1345.  * The predefined ACE types (8-bit, see below).
  1346.  */
  1347. typedef enum {
  1348.     ACCESS_MIN_MS_ACE_TYPE        = 0,
  1349.     ACCESS_ALLOWED_ACE_TYPE        = 0,
  1350.     ACCESS_DENIED_ACE_TYPE        = 1,
  1351.     SYSTEM_AUDIT_ACE_TYPE        = 2,
  1352.     SYSTEM_ALARM_ACE_TYPE        = 3, /* Not implemented as of Win2k. */
  1353.     ACCESS_MAX_MS_V2_ACE_TYPE    = 3,
  1354.  
  1355.     ACCESS_ALLOWED_COMPOUND_ACE_TYPE= 4,
  1356.     ACCESS_MAX_MS_V3_ACE_TYPE    = 4,
  1357.  
  1358.     /* The following are Win2k only. */
  1359.     ACCESS_MIN_MS_OBJECT_ACE_TYPE    = 5,
  1360.     ACCESS_ALLOWED_OBJECT_ACE_TYPE    = 5,
  1361.     ACCESS_DENIED_OBJECT_ACE_TYPE    = 6,
  1362.     SYSTEM_AUDIT_OBJECT_ACE_TYPE    = 7,
  1363.     SYSTEM_ALARM_OBJECT_ACE_TYPE    = 8,
  1364.     ACCESS_MAX_MS_OBJECT_ACE_TYPE    = 8,
  1365.  
  1366.     ACCESS_MAX_MS_V4_ACE_TYPE    = 8,
  1367.  
  1368.     /* This one is for WinNT&2k. */
  1369.     ACCESS_MAX_MS_ACE_TYPE        = 8,
  1370. } __attribute__ ((__packed__)) ACE_TYPES;
  1371.  
  1372. /*
  1373.  * The ACE flags (8-bit) for audit and inheritance (see below).
  1374.  *
  1375.  * SUCCESSFUL_ACCESS_ACE_FLAG is only used with system audit and alarm ACE
  1376.  * types to indicate that a message is generated (in Windows!) for successful
  1377.  * accesses.
  1378.  *
  1379.  * FAILED_ACCESS_ACE_FLAG is only used with system audit and alarm ACE types
  1380.  * to indicate that a message is generated (in Windows!) for failed accesses.
  1381.  */
  1382. typedef enum {
  1383.     /* The inheritance flags. */
  1384.     OBJECT_INHERIT_ACE        = 0x01,
  1385.     CONTAINER_INHERIT_ACE        = 0x02,
  1386.     NO_PROPAGATE_INHERIT_ACE    = 0x04,
  1387.     INHERIT_ONLY_ACE        = 0x08,
  1388.     INHERITED_ACE            = 0x10,    /* Win2k only. */
  1389.     VALID_INHERIT_FLAGS        = 0x1f,
  1390.  
  1391.     /* The audit flags. */
  1392.     SUCCESSFUL_ACCESS_ACE_FLAG    = 0x40,
  1393.     FAILED_ACCESS_ACE_FLAG        = 0x80,
  1394. } __attribute__ ((__packed__)) ACE_FLAGS;
  1395.  
  1396. /*
  1397.  * An ACE is an access-control entry in an access-control list (ACL).
  1398.  * An ACE defines access to an object for a specific user or group or defines
  1399.  * the types of access that generate system-administration messages or alarms
  1400.  * for a specific user or group. The user or group is identified by a security
  1401.  * identifier (SID).
  1402.  *
  1403.  * Each ACE starts with an ACE_HEADER structure (aligned on 4-byte boundary),
  1404.  * which specifies the type and size of the ACE. The format of the subsequent
  1405.  * data depends on the ACE type.
  1406.  */
  1407. typedef struct {
  1408.     ACE_TYPES type;        /* Type of the ACE. */
  1409.     ACE_FLAGS flags;    /* Flags describing the ACE. */
  1410.     u16 size;        /* Size in bytes of the ACE. */
  1411. } __attribute__ ((__packed__)) ACE_HEADER;
  1412.  
  1413. /*
  1414.  * The access mask (32-bit). Defines the access rights.
  1415.  */
  1416. typedef enum {
  1417.     /*
  1418.      * The specific rights (bits 0 to 15). Depend on the type of the
  1419.      * object being secured by the ACE.
  1420.      */
  1421.  
  1422.     /* Specific rights for files and directories are as follows: */
  1423.  
  1424.     /* Right to read data from the file. (FILE) */
  1425.     FILE_READ_DATA            = const_cpu_to_le32(0x00000001),
  1426.     /* Right to list contents of a directory. (DIRECTORY) */
  1427.     FILE_LIST_DIRECTORY        = const_cpu_to_le32(0x00000001),
  1428.  
  1429.     /* Right to write data to the file. (FILE) */
  1430.     FILE_WRITE_DATA            = const_cpu_to_le32(0x00000002),
  1431.     /* Right to create a file in the directory. (DIRECTORY) */
  1432.     FILE_ADD_FILE            = const_cpu_to_le32(0x00000002),
  1433.  
  1434.     /* Right to append data to the file. (FILE) */
  1435.     FILE_APPEND_DATA        = const_cpu_to_le32(0x00000004),
  1436.     /* Right to create a subdirectory. (DIRECTORY) */
  1437.     FILE_ADD_SUBDIRECTORY        = const_cpu_to_le32(0x00000004),
  1438.  
  1439.     /* Right to read extended attributes. (FILE/DIRECTORY) */
  1440.     FILE_READ_EA            = const_cpu_to_le32(0x00000008),
  1441.  
  1442.     /* Right to write extended attributes. (FILE/DIRECTORY) */
  1443.     FILE_WRITE_EA            = const_cpu_to_le32(0x00000010),
  1444.  
  1445.     /* Right to execute a file. (FILE) */
  1446.     FILE_EXECUTE            = const_cpu_to_le32(0x00000020),
  1447.     /* Right to traverse the directory. (DIRECTORY) */
  1448.     FILE_TRAVERSE            = const_cpu_to_le32(0x00000020),
  1449.  
  1450.     /*
  1451.      * Right to delete a directory and all the files it contains (its
  1452.      * children), even if the files are read-only. (DIRECTORY)
  1453.      */
  1454.     FILE_DELETE_CHILD        = const_cpu_to_le32(0x00000040),
  1455.  
  1456.     /* Right to read file attributes. (FILE/DIRECTORY) */
  1457.     FILE_READ_ATTRIBUTES        = const_cpu_to_le32(0x00000080),
  1458.  
  1459.     /* Right to change file attributes. (FILE/DIRECTORY) */
  1460.     FILE_WRITE_ATTRIBUTES        = const_cpu_to_le32(0x00000100),
  1461.  
  1462.     /*
  1463.      * The standard rights (bits 16 to 23). Are independent of the type of
  1464.      * object being secured.
  1465.      */
  1466.  
  1467.     /* Right to delete the object. */
  1468.     DELETE                = const_cpu_to_le32(0x00010000),
  1469.  
  1470.     /*
  1471.      * Right to read the information in the object's security descriptor,
  1472.      * not including the information in the SACL. I.e. right to read the
  1473.      * security descriptor and owner.
  1474.      */
  1475.     READ_CONTROL            = const_cpu_to_le32(0x00020000),
  1476.  
  1477.     /* Right to modify the DACL in the object's security descriptor. */
  1478.     WRITE_DAC            = const_cpu_to_le32(0x00040000),
  1479.  
  1480.     /* Right to change the owner in the object's security descriptor. */
  1481.     WRITE_OWNER            = const_cpu_to_le32(0x00080000),
  1482.  
  1483.     /*
  1484.      * Right to use the object for synchronization. Enables a process to
  1485.      * wait until the object is in the signalled state. Some object types
  1486.      * do not support this access right.
  1487.      */
  1488.     SYNCHRONIZE            = const_cpu_to_le32(0x00100000),
  1489.  
  1490.     /*
  1491.      * The following STANDARD_RIGHTS_* are combinations of the above for
  1492.      * convenience and are defined by the Win32 API.
  1493.      */
  1494.  
  1495.     /* These are currently defined to READ_CONTROL. */
  1496.     STANDARD_RIGHTS_READ        = const_cpu_to_le32(0x00020000),
  1497.     STANDARD_RIGHTS_WRITE        = const_cpu_to_le32(0x00020000),
  1498.     STANDARD_RIGHTS_EXECUTE        = const_cpu_to_le32(0x00020000),
  1499.  
  1500.     /* Combines DELETE, READ_CONTROL, WRITE_DAC, and WRITE_OWNER access. */
  1501.     STANDARD_RIGHTS_REQUIRED    = const_cpu_to_le32(0x000f0000),
  1502.  
  1503.     /*
  1504.      * Combines DELETE, READ_CONTROL, WRITE_DAC, WRITE_OWNER, and
  1505.      * SYNCHRONIZE access.
  1506.      */
  1507.     STANDARD_RIGHTS_ALL        = const_cpu_to_le32(0x001f0000),
  1508.  
  1509.     /*
  1510.      * The access system ACL and maximum allowed access types (bits 24 to
  1511.      * 25, bits 26 to 27 are reserved).
  1512.      */
  1513.     ACCESS_SYSTEM_SECURITY        = const_cpu_to_le32(0x01000000),
  1514.     MAXIMUM_ALLOWED            = const_cpu_to_le32(0x02000000),
  1515.  
  1516.     /*
  1517.      * The generic rights (bits 28 to 31). These map onto the standard and
  1518.      * specific rights.
  1519.      */
  1520.  
  1521.     /* Read, write, and execute access. */
  1522.     GENERIC_ALL            = const_cpu_to_le32(0x10000000),
  1523.  
  1524.     /* Execute access. */
  1525.     GENERIC_EXECUTE            = const_cpu_to_le32(0x20000000),
  1526.  
  1527.     /*
  1528.      * Write access. For files, this maps onto:
  1529.      *    FILE_APPEND_DATA | FILE_WRITE_ATTRIBUTES | FILE_WRITE_DATA |
  1530.      *    FILE_WRITE_EA | STANDARD_RIGHTS_WRITE | SYNCHRONIZE
  1531.      * For directories, the mapping has the same numerical value. See
  1532.      * above for the descriptions of the rights granted.
  1533.      */
  1534.     GENERIC_WRITE            = const_cpu_to_le32(0x40000000),
  1535.  
  1536.     /*
  1537.      * Read access. For files, this maps onto:
  1538.      *    FILE_READ_ATTRIBUTES | FILE_READ_DATA | FILE_READ_EA |
  1539.      *    STANDARD_RIGHTS_READ | SYNCHRONIZE
  1540.      * For directories, the mapping has the same numerical value. See
  1541.      * above for the descriptions of the rights granted.
  1542.      */
  1543.     GENERIC_READ            = const_cpu_to_le32(0x80000000),
  1544. } ACCESS_MASK;
  1545.  
  1546. /*
  1547.  * The generic mapping array. Used to denote the mapping of each generic
  1548.  * access right to a specific access mask.
  1549.  *
  1550.  * FIXME: What exactly is this and what is it for? (AIA)
  1551.  */
  1552. typedef struct {
  1553.     ACCESS_MASK generic_read;
  1554.     ACCESS_MASK generic_write;
  1555.     ACCESS_MASK generic_execute;
  1556.     ACCESS_MASK generic_all;
  1557. } __attribute__ ((__packed__)) GENERIC_MAPPING;
  1558.  
  1559. /*
  1560.  * The predefined ACE type structures are as defined below.
  1561.  */
  1562.  
  1563. /*
  1564.  * ACCESS_ALLOWED_ACE, ACCESS_DENIED_ACE, SYSTEM_AUDIT_ACE, SYSTEM_ALARM_ACE
  1565.  */
  1566. typedef struct {
  1567. /*  0    ACE_HEADER; -- Unfolded here as gcc doesn't like unnamed structs. */
  1568.     ACE_TYPES type;        /* Type of the ACE. */
  1569.     ACE_FLAGS flags;    /* Flags describing the ACE. */
  1570.     u16 size;        /* Size in bytes of the ACE. */
  1571.  
  1572. /*  4*/    ACCESS_MASK mask;    /* Access mask associated with the ACE. */
  1573. /*  8*/    SID sid;        /* The SID associated with the ACE. */
  1574. } __attribute__ ((__packed__)) ACCESS_ALLOWED_ACE, ACCESS_DENIED_ACE,
  1575.                    SYSTEM_AUDIT_ACE, SYSTEM_ALARM_ACE;
  1576.  
  1577. /*
  1578.  * The object ACE flags (32-bit).
  1579.  */
  1580. typedef enum {
  1581.     ACE_OBJECT_TYPE_PRESENT            = const_cpu_to_le32(1),
  1582.     ACE_INHERITED_OBJECT_TYPE_PRESENT    = const_cpu_to_le32(2),
  1583. } OBJECT_ACE_FLAGS;
  1584.  
  1585. typedef struct {
  1586. /*  0    ACE_HEADER; -- Unfolded here as gcc doesn't like unnamed structs. */
  1587.     ACE_TYPES type;        /* Type of the ACE. */
  1588.     ACE_FLAGS flags;    /* Flags describing the ACE. */
  1589.     u16 size;        /* Size in bytes of the ACE. */
  1590.  
  1591. /*  4*/    ACCESS_MASK mask;    /* Access mask associated with the ACE. */
  1592. /*  8*/    OBJECT_ACE_FLAGS object_flags;    /* Flags describing the object ACE. */
  1593. /* 12*/    GUID object_type;
  1594. /* 28*/    GUID inherited_object_type;
  1595. /* 44*/    SID sid;        /* The SID associated with the ACE. */
  1596. } __attribute__ ((__packed__)) ACCESS_ALLOWED_OBJECT_ACE,
  1597.                    ACCESS_DENIED_OBJECT_ACE,
  1598.                    SYSTEM_AUDIT_OBJECT_ACE,
  1599.                    SYSTEM_ALARM_OBJECT_ACE;
  1600.  
  1601. /*
  1602.  * An ACL is an access-control list (ACL).
  1603.  * An ACL starts with an ACL header structure, which specifies the size of
  1604.  * the ACL and the number of ACEs it contains. The ACL header is followed by
  1605.  * zero or more access control entries (ACEs). The ACL as well as each ACE
  1606.  * are aligned on 4-byte boundaries.
  1607.  */
  1608. typedef struct {
  1609.     u8 revision;    /* Revision of this ACL. */
  1610.     u8 alignment1;
  1611.     u16 size;    /* Allocated space in bytes for ACL. Includes this
  1612.                header, the ACEs and the remaining free space. */
  1613.     u16 ace_count;    /* Number of ACEs in the ACL. */
  1614.     u16 alignment2;
  1615. /* sizeof() = 8 bytes */
  1616. } __attribute__ ((__packed__)) ACL;
  1617.  
  1618. /*
  1619.  * Current constants for ACLs.
  1620.  */
  1621. typedef enum {
  1622.     /* Current revision. */
  1623.     ACL_REVISION        = 2,
  1624.     ACL_REVISION_DS        = 4,
  1625.  
  1626.     /* History of revisions. */
  1627.     ACL_REVISION1        = 1,
  1628.     MIN_ACL_REVISION    = 2,
  1629.     ACL_REVISION2        = 2,
  1630.     ACL_REVISION3        = 3,
  1631.     ACL_REVISION4        = 4,
  1632.     MAX_ACL_REVISION    = 4,
  1633. } ACL_CONSTANTS;
  1634.  
  1635. /*
  1636.  * The security descriptor control flags (16-bit).
  1637.  *
  1638.  * SE_OWNER_DEFAULTED - This boolean flag, when set, indicates that the
  1639.  *    SID pointed to by the Owner field was provided by a
  1640.  *    defaulting mechanism rather than explicitly provided by the
  1641.  *    original provider of the security descriptor.  This may
  1642.  *    affect the treatment of the SID with respect to inheritance
  1643.  *    of an owner.
  1644.  *
  1645.  * SE_GROUP_DEFAULTED - This boolean flag, when set, indicates that the
  1646.  *    SID in the Group field was provided by a defaulting mechanism
  1647.  *    rather than explicitly provided by the original provider of
  1648.  *    the security descriptor.  This may affect the treatment of
  1649.  *    the SID with respect to inheritance of a primary group.
  1650.  *
  1651.  * SE_DACL_PRESENT - This boolean flag, when set, indicates that the
  1652.  *    security descriptor contains a discretionary ACL.  If this
  1653.  *    flag is set and the Dacl field of the SECURITY_DESCRIPTOR is
  1654.  *    null, then a null ACL is explicitly being specified.
  1655.  *
  1656.  * SE_DACL_DEFAULTED - This boolean flag, when set, indicates that the
  1657.  *    ACL pointed to by the Dacl field was provided by a defaulting
  1658.  *    mechanism rather than explicitly provided by the original
  1659.  *    provider of the security descriptor.  This may affect the
  1660.  *    treatment of the ACL with respect to inheritance of an ACL.
  1661.  *    This flag is ignored if the DaclPresent flag is not set.
  1662.  *
  1663.  * SE_SACL_PRESENT - This boolean flag, when set,  indicates that the
  1664.  *    security descriptor contains a system ACL pointed to by the
  1665.  *    Sacl field.  If this flag is set and the Sacl field of the
  1666.  *    SECURITY_DESCRIPTOR is null, then an empty (but present)
  1667.  *    ACL is being specified.
  1668.  *
  1669.  * SE_SACL_DEFAULTED - This boolean flag, when set, indicates that the
  1670.  *    ACL pointed to by the Sacl field was provided by a defaulting
  1671.  *    mechanism rather than explicitly provided by the original
  1672.  *    provider of the security descriptor.  This may affect the
  1673.  *    treatment of the ACL with respect to inheritance of an ACL.
  1674.  *    This flag is ignored if the SaclPresent flag is not set.
  1675.  *
  1676.  * SE_SELF_RELATIVE - This boolean flag, when set, indicates that the
  1677.  *    security descriptor is in self-relative form.  In this form,
  1678.  *    all fields of the security descriptor are contiguous in memory
  1679.  *    and all pointer fields are expressed as offsets from the
  1680.  *    beginning of the security descriptor.
  1681.  */
  1682. typedef enum {
  1683.     SE_OWNER_DEFAULTED        = const_cpu_to_le16(0x0001),
  1684.     SE_GROUP_DEFAULTED        = const_cpu_to_le16(0x0002),
  1685.     SE_DACL_PRESENT            = const_cpu_to_le16(0x0004),
  1686.     SE_DACL_DEFAULTED        = const_cpu_to_le16(0x0008),
  1687.     SE_SACL_PRESENT            = const_cpu_to_le16(0x0010),
  1688.     SE_SACL_DEFAULTED        = const_cpu_to_le16(0x0020),
  1689.     SE_DACL_AUTO_INHERIT_REQ    = const_cpu_to_le16(0x0100),
  1690.     SE_SACL_AUTO_INHERIT_REQ    = const_cpu_to_le16(0x0200),
  1691.     SE_DACL_AUTO_INHERITED        = const_cpu_to_le16(0x0400),
  1692.     SE_SACL_AUTO_INHERITED        = const_cpu_to_le16(0x0800),
  1693.     SE_DACL_PROTECTED        = const_cpu_to_le16(0x1000),
  1694.     SE_SACL_PROTECTED        = const_cpu_to_le16(0x2000),
  1695.     SE_RM_CONTROL_VALID        = const_cpu_to_le16(0x4000),
  1696.     SE_SELF_RELATIVE        = const_cpu_to_le16(0x8000),
  1697. } __attribute__ ((__packed__)) SECURITY_DESCRIPTOR_CONTROL;
  1698.  
  1699. /*
  1700.  * Self-relative security descriptor. Contains the owner and group SIDs as well
  1701.  * as the sacl and dacl ACLs inside the security descriptor itself.
  1702.  */
  1703. typedef struct {
  1704.     u8 revision;    /* Revision level of the security descriptor. */
  1705.     u8 alignment;
  1706.     SECURITY_DESCRIPTOR_CONTROL control; /* Flags qualifying the type of
  1707.                the descriptor as well as the following fields. */
  1708.     u32 owner;    /* Byte offset to a SID representing an object's
  1709.                owner. If this is NULL, no owner SID is present in
  1710.                the descriptor. */
  1711.     u32 group;    /* Byte offset to a SID representing an object's
  1712.                primary group. If this is NULL, no primary group
  1713.                SID is present in the descriptor. */
  1714.     u32 sacl;    /* Byte offset to a system ACL. Only valid, if
  1715.                SE_SACL_PRESENT is set in the control field. If
  1716.                SE_SACL_PRESENT is set but sacl is NULL, a NULL ACL
  1717.                is specified. */
  1718.     u32 dacl;    /* Byte offset to a discretionary ACL. Only valid, if
  1719.                SE_DACL_PRESENT is set in the control field. If
  1720.                SE_DACL_PRESENT is set but dacl is NULL, a NULL ACL
  1721.                (unconditionally granting access) is specified. */
  1722. /* sizeof() = 0x14 bytes */
  1723. } __attribute__ ((__packed__)) SECURITY_DESCRIPTOR_RELATIVE;
  1724.  
  1725. /*
  1726.  * Absolute security descriptor. Does not contain the owner and group SIDs, nor
  1727.  * the sacl and dacl ACLs inside the security descriptor. Instead, it contains
  1728.  * pointers to these structures in memory. Obviously, absolute security
  1729.  * descriptors are only useful for in memory representations of security
  1730.  * descriptors. On disk, a self-relative security descriptor is used.
  1731.  */
  1732. typedef struct {
  1733.     u8 revision;    /* Revision level of the security descriptor. */
  1734.     u8 alignment;
  1735.     SECURITY_DESCRIPTOR_CONTROL control;    /* Flags qualifying the type of
  1736.                the descriptor as well as the following fields. */
  1737.     SID *owner;    /* Points to a SID representing an object's owner. If
  1738.                this is NULL, no owner SID is present in the
  1739.                descriptor. */
  1740.     SID *group;    /* Points to a SID representing an object's primary
  1741.                group. If this is NULL, no primary group SID is
  1742.                present in the descriptor. */
  1743.     ACL *sacl;    /* Points to a system ACL. Only valid, if
  1744.                SE_SACL_PRESENT is set in the control field. If
  1745.                SE_SACL_PRESENT is set but sacl is NULL, a NULL ACL
  1746.                is specified. */
  1747.     ACL *dacl;    /* Points to a discretionary ACL. Only valid, if
  1748.                SE_DACL_PRESENT is set in the control field. If
  1749.                SE_DACL_PRESENT is set but dacl is NULL, a NULL ACL
  1750.                (unconditionally granting access) is specified. */
  1751. } __attribute__ ((__packed__)) SECURITY_DESCRIPTOR;
  1752.  
  1753. /*
  1754.  * Current constants for security descriptors.
  1755.  */
  1756. typedef enum {
  1757.     /* Current revision. */
  1758.     SECURITY_DESCRIPTOR_REVISION    = 1,
  1759.     SECURITY_DESCRIPTOR_REVISION1    = 1,
  1760.  
  1761.     /* The sizes of both the absolute and relative security descriptors is
  1762.        the same as pointers, at least on ia32 architecture are 32-bit. */
  1763.     SECURITY_DESCRIPTOR_MIN_LENGTH    = sizeof(SECURITY_DESCRIPTOR),
  1764. } SECURITY_DESCRIPTOR_CONSTANTS;
  1765.  
  1766. /*
  1767.  * Attribute: Security descriptor (0x50). A standard self-relative security
  1768.  * descriptor.
  1769.  *
  1770.  * NOTE: Can be resident or non-resident.
  1771.  * NOTE: Not used in NTFS 3.0+, as security descriptors are stored centrally
  1772.  * in FILE_Secure and the correct descriptor is found using the security_id
  1773.  * from the standard information attribute.
  1774.  */
  1775. typedef SECURITY_DESCRIPTOR_RELATIVE SECURITY_DESCRIPTOR_ATTR;
  1776.  
  1777. /*
  1778.  * On NTFS 3.0+, all security descriptors are stored in FILE_Secure. Only one
  1779.  * referenced instance of each unique security descriptor is stored.
  1780.  *
  1781.  * FILE_Secure contains no unnamed data attribute, i.e. it has zero length. It
  1782.  * does, however, contain two indexes ($SDH and $SII) as well as a named data
  1783.  * stream ($SDS).
  1784.  *
  1785.  * Every unique security descriptor is assigned a unique security identifier
  1786.  * (security_id, not to be confused with a SID). The security_id is unique for
  1787.  * the NTFS volume and is used as an index into the $SII index, which maps
  1788.  * security_ids to the security descriptor's storage location within the $SDS
  1789.  * data attribute. The $SII index is sorted by ascending security_id.
  1790.  *
  1791.  * A simple hash is computed from each security descriptor. This hash is used
  1792.  * as an index into the $SDH index, which maps security descriptor hashes to
  1793.  * the security descriptor's storage location within the $SDS data attribute.
  1794.  * The $SDH index is sorted by security descriptor hash and is stored in a B+
  1795.  * tree. When searching $SDH (with the intent of determining whether or not a
  1796.  * new security descriptor is already present in the $SDS data stream), if a
  1797.  * matching hash is found, but the security descriptors do not match, the
  1798.  * search in the $SDH index is continued, searching for a next matching hash.
  1799.  *
  1800.  * When a precise match is found, the security_id corresponding to the security
  1801.  * descriptor in the $SDS attribute is read from the found $SDH index entry and
  1802.  * is stored in the $STANDARD_INFORMATION attribute of the file/directory to
  1803.  * which the security descriptor is being applied. The $STANDARD_INFORMATION
  1804.  * attribute is present in all base mft records (i.e. in all files and
  1805.  * directories).
  1806.  *
  1807.  * If a match is not found, the security descriptor is assigned a new unique
  1808.  * security_id and is added to the $SDS data attribute. Then, entries
  1809.  * referencing the this security descriptor in the $SDS data attribute are
  1810.  * added to the $SDH and $SII indexes.
  1811.  *
  1812.  * Note: Entries are never deleted from FILE_Secure, even if nothing
  1813.  * references an entry any more.
  1814.  */
  1815.  
  1816. /*
  1817.  * This header precedes each security descriptor in the $SDS data stream.
  1818.  * This is also the index entry data part of both the $SII and $SDH indexes.
  1819.  */
  1820. typedef struct {
  1821.     u32 hash;       /* Hash of the security descriptor. */
  1822.     u32 security_id;   /* The security_id assigned to the descriptor. */
  1823.     u64 offset;       /* Byte offset of this entry in the $SDS stream. */
  1824.     u32 length;       /* Size in bytes of this entry in $SDS stream. */
  1825. } __attribute__ ((__packed__)) SECURITY_DESCRIPTOR_HEADER;
  1826.  
  1827. /*
  1828.  * The $SDS data stream contains the security descriptors, aligned on 16-byte
  1829.  * boundaries, sorted by security_id in a B+ tree. Security descriptors cannot
  1830.  * cross 256kib boundaries (this restriction is imposed by the Windows cache
  1831.  * manager). Each security descriptor is contained in a SDS_ENTRY structure.
  1832.  * Also, each security descriptor is stored twice in the $SDS stream with a
  1833.  * fixed offset of 0x40000 bytes (256kib, the Windows cache manager's max size)
  1834.  * between them; i.e. if a SDS_ENTRY specifies an offset of 0x51d0, then the
  1835.  * the first copy of the security descriptor will be at offset 0x51d0 in the
  1836.  * $SDS data stream and the second copy will be at offset 0x451d0.
  1837.  */
  1838. typedef struct {
  1839. /*  0    SECURITY_DESCRIPTOR_HEADER; -- Unfolded here as gcc doesn't like
  1840.                        unnamed structs. */
  1841.     u32 hash;       /* Hash of the security descriptor. */
  1842.     u32 security_id;   /* The security_id assigned to the descriptor. */
  1843.     u64 offset;       /* Byte offset of this entry in the $SDS stream. */
  1844.     u32 length;       /* Size in bytes of this entry in $SDS stream. */
  1845. /* 20*/    SECURITY_DESCRIPTOR_RELATIVE sid; /* The self-relative security
  1846.                          descriptor. */
  1847. } __attribute__ ((__packed__)) SDS_ENTRY;
  1848.  
  1849. /*
  1850.  * The index entry key used in the $SII index. The collation type is
  1851.  * COLLATION_NTOFS_ULONG.
  1852.  */
  1853. typedef struct {
  1854.     u32 security_id;   /* The security_id assigned to the descriptor. */
  1855. } __attribute__ ((__packed__)) SII_INDEX_KEY;
  1856.  
  1857. /*
  1858.  * The index entry key used in the $SDH index. The keys are sorted first by
  1859.  * hash and then by security_id. The collation rule is
  1860.  * COLLATION_NTOFS_SECURITY_HASH.
  1861.  */
  1862. typedef struct {
  1863.     u32 hash;       /* Hash of the security descriptor. */
  1864.     u32 security_id;   /* The security_id assigned to the descriptor. */
  1865. } __attribute__ ((__packed__)) SDH_INDEX_KEY;
  1866.  
  1867. /*
  1868.  * Attribute: Volume name (0x60).
  1869.  *
  1870.  * NOTE: Always resident.
  1871.  * NOTE: Present only in FILE_Volume.
  1872.  */
  1873. typedef struct {
  1874.     ntfschar name[0];    /* The name of the volume in Unicode. */
  1875. } __attribute__ ((__packed__)) VOLUME_NAME;
  1876.  
  1877. /*
  1878.  * Possible flags for the volume (16-bit).
  1879.  */
  1880. typedef enum {
  1881.     VOLUME_IS_DIRTY            = const_cpu_to_le16(0x0001),
  1882.     VOLUME_RESIZE_LOG_FILE        = const_cpu_to_le16(0x0002),
  1883.     VOLUME_UPGRADE_ON_MOUNT        = const_cpu_to_le16(0x0004),
  1884.     VOLUME_MOUNTED_ON_NT4        = const_cpu_to_le16(0x0008),
  1885.     VOLUME_DELETE_USN_UNDERWAY    = const_cpu_to_le16(0x0010),
  1886.     VOLUME_REPAIR_OBJECT_ID        = const_cpu_to_le16(0x0020),
  1887.     VOLUME_MODIFIED_BY_CHKDSK    = const_cpu_to_le16(0x8000),
  1888.     VOLUME_FLAGS_MASK        = const_cpu_to_le16(0x803f),
  1889. } __attribute__ ((__packed__)) VOLUME_FLAGS;
  1890.  
  1891. /*
  1892.  * Attribute: Volume information (0x70).
  1893.  *
  1894.  * NOTE: Always resident.
  1895.  * NOTE: Present only in FILE_Volume.
  1896.  * NOTE: Windows 2000 uses NTFS 3.0 while Windows NT4 service pack 6a uses
  1897.  *     NTFS 1.2. I haven't personally seen other values yet.
  1898.  */
  1899. typedef struct {
  1900.     u64 reserved;        /* Not used (yet?). */
  1901.     u8 major_ver;        /* Major version of the ntfs format. */
  1902.     u8 minor_ver;        /* Minor version of the ntfs format. */
  1903.     VOLUME_FLAGS flags;    /* Bit array of VOLUME_* flags. */
  1904. } __attribute__ ((__packed__)) VOLUME_INFORMATION;
  1905.  
  1906. /*
  1907.  * Attribute: Data attribute (0x80).
  1908.  *
  1909.  * NOTE: Can be resident or non-resident.
  1910.  *
  1911.  * Data contents of a file (i.e. the unnamed stream) or of a named stream.
  1912.  */
  1913. typedef struct {
  1914.     u8 data[0];        /* The file's data contents. */
  1915. } __attribute__ ((__packed__)) DATA_ATTR;
  1916.  
  1917. /*
  1918.  * Index header flags (8-bit).
  1919.  */
  1920. typedef enum {
  1921.     /* When index header is in an index root attribute: */
  1922.     SMALL_INDEX    = 0, /* The index is small enough to fit inside the
  1923.                 index root attribute and there is no index
  1924.                 allocation attribute present. */
  1925.     LARGE_INDEX    = 1, /* The index is too large to fit in the index
  1926.                 root attribute and/or an index allocation
  1927.                 attribute is present. */
  1928.     /*
  1929.      * When index header is in an index block, i.e. is part of index
  1930.      * allocation attribute:
  1931.      */
  1932.     LEAF_NODE    = 0, /* This is a leaf node, i.e. there are no more
  1933.                 nodes branching off it. */
  1934.     INDEX_NODE    = 1, /* This node indexes other nodes, i.e. is not a
  1935.                 leaf node. */
  1936.     NODE_MASK    = 1, /* Mask for accessing the *_NODE bits. */
  1937. } __attribute__ ((__packed__)) INDEX_HEADER_FLAGS;
  1938.  
  1939. /*
  1940.  * This is the header for indexes, describing the INDEX_ENTRY records, which
  1941.  * follow the INDEX_HEADER. Together the index header and the index entries
  1942.  * make up a complete index.
  1943.  *
  1944.  * IMPORTANT NOTE: The offset, length and size structure members are counted
  1945.  * relative to the start of the index header structure and not relative to the
  1946.  * start of the index root or index allocation structures themselves.
  1947.  */
  1948. typedef struct {
  1949.     u32 entries_offset;        /* Byte offset to first INDEX_ENTRY
  1950.                        aligned to 8-byte boundary. */
  1951.     u32 index_length;        /* Data size of the index in bytes,
  1952.                        i.e. bytes used from allocated
  1953.                        size, aligned to 8-byte boundary. */
  1954.     u32 allocated_size;        /* Byte size of this index (block),
  1955.                        multiple of 8 bytes. */
  1956.     /* NOTE: For the index root attribute, the above two numbers are always
  1957.        equal, as the attribute is resident and it is resized as needed. In
  1958.        the case of the index allocation attribute the attribute is not
  1959.        resident and hence the allocated_size is a fixed value and must
  1960.        equal the index_block_size specified by the INDEX_ROOT attribute
  1961.        corresponding to the INDEX_ALLOCATION attribute this INDEX_BLOCK
  1962.        belongs to. */
  1963.     INDEX_HEADER_FLAGS flags;    /* Bit field of INDEX_HEADER_FLAGS. */
  1964.     u8 reserved[3];            /* Reserved/align to 8-byte boundary. */
  1965. } __attribute__ ((__packed__)) INDEX_HEADER;
  1966.  
  1967. /*
  1968.  * Attribute: Index root (0x90).
  1969.  *
  1970.  * NOTE: Always resident.
  1971.  *
  1972.  * This is followed by a sequence of index entries (INDEX_ENTRY structures)
  1973.  * as described by the index header.
  1974.  *
  1975.  * When a directory is small enough to fit inside the index root then this
  1976.  * is the only attribute describing the directory. When the directory is too
  1977.  * large to fit in the index root, on the other hand, two additional attributes
  1978.  * are present: an index allocation attribute, containing sub-nodes of the B+
  1979.  * directory tree (see below), and a bitmap attribute, describing which virtual
  1980.  * cluster numbers (vcns) in the index allocation attribute are in use by an
  1981.  * index block.
  1982.  *
  1983.  * NOTE: The root directory (FILE_root) contains an entry for itself. Other
  1984.  * directories do not contain entries for themselves, though.
  1985.  */
  1986. typedef struct {
  1987.     ATTR_TYPES type;        /* Type of the indexed attribute. Is
  1988.                        $FILE_NAME for directories, zero
  1989.                        for view indexes. No other values
  1990.                        allowed. */
  1991.     COLLATION_RULES collation_rule;    /* Collation rule used to sort the
  1992.                        index entries. If type is $FILE_NAME,
  1993.                        this must be COLLATION_FILE_NAME. */
  1994.     u32 index_block_size;        /* Size of each index block in bytes (in
  1995.                        the index allocation attribute). */
  1996.     s8 clusters_per_index_block;    /* Cluster size of each index block (in
  1997.                        the index allocation attribute), when
  1998.                        an index block is >= than a cluster,
  1999.                        otherwise this will be the -log of
  2000.                        the size (like how the encoding of
  2001.                        the mft record size and the index
  2002.                        record size found in the boot sector
  2003.                        work). Has to be a power of 2. */
  2004.     u8 reserved[3];            /* Reserved/align to 8-byte boundary. */
  2005.     INDEX_HEADER index;        /* Index header describing the
  2006.                        following index entries. */
  2007. } __attribute__ ((__packed__)) INDEX_ROOT;
  2008.  
  2009. /*
  2010.  * Attribute: Index allocation (0xa0).
  2011.  *
  2012.  * NOTE: Always non-resident (doesn't make sense to be resident anyway!).
  2013.  *
  2014.  * This is an array of index blocks. Each index block starts with an
  2015.  * INDEX_BLOCK structure containing an index header, followed by a sequence of
  2016.  * index entries (INDEX_ENTRY structures), as described by the INDEX_HEADER.
  2017.  */
  2018. typedef struct {
  2019. /*  0    NTFS_RECORD; -- Unfolded here as gcc doesn't like unnamed structs. */
  2020.     NTFS_RECORD_TYPES magic;/* Magic is "INDX". */
  2021.     u16 usa_ofs;        /* See NTFS_RECORD definition. */
  2022.     u16 usa_count;        /* See NTFS_RECORD definition. */
  2023.  
  2024. /*  8*/    LSN lsn;        /* $LogFile sequence number of the last
  2025.                    modification of this index block. */
  2026. /* 16*/    VCN index_block_vcn;    /* Virtual cluster number of the index block. */
  2027. /* 24*/    INDEX_HEADER index;    /* Describes the following index entries. */
  2028. /* sizeof()= 40 (0x28) bytes */
  2029. /*
  2030.  * When creating the index block, we place the update sequence array at this
  2031.  * offset, i.e. before we start with the index entries. This also makes sense,
  2032.  * otherwise we could run into problems with the update sequence array
  2033.  * containing in itself the last two bytes of a sector which would mean that
  2034.  * multi sector transfer protection wouldn't work. As you can't protect data
  2035.  * by overwriting it since you then can't get it back...
  2036.  * When reading use the data from the ntfs record header.
  2037.  */
  2038. } __attribute__ ((__packed__)) INDEX_BLOCK;
  2039.  
  2040. typedef INDEX_BLOCK INDEX_ALLOCATION;
  2041.  
  2042. /*
  2043.  * The system file FILE_Extend/$Reparse contains an index named $R listing
  2044.  * all reparse points on the volume. The index entry keys are as defined
  2045.  * below. Note, that there is no index data associated with the index entries.
  2046.  *
  2047.  * The index entries are sorted by the index key file_id. The collation rule is
  2048.  * COLLATION_NTOFS_ULONGS. FIXME: Verify whether the reparse_tag is not the
  2049.  * primary key / is not a key at all. (AIA)
  2050.  */
  2051. typedef struct {
  2052.     u32 reparse_tag;    /* Reparse point type (inc. flags). */
  2053.     MFT_REF file_id;    /* Mft record of the file containing the
  2054.                    reparse point attribute. */
  2055. } __attribute__ ((__packed__)) REPARSE_INDEX_KEY;
  2056.  
  2057. /*
  2058.  * Quota flags (32-bit).
  2059.  */
  2060. typedef enum {
  2061.     /* The user quota flags. Names explain meaning. */
  2062.     QUOTA_FLAG_DEFAULT_LIMITS    = const_cpu_to_le32(0x00000001),
  2063.     QUOTA_FLAG_LIMIT_REACHED    = const_cpu_to_le32(0x00000002),
  2064.     QUOTA_FLAG_ID_DELETED        = const_cpu_to_le32(0x00000004),
  2065.  
  2066.     QUOTA_FLAG_USER_MASK        = const_cpu_to_le32(0x00000007),
  2067.         /* Bit mask for user quota flags. */
  2068.  
  2069.     /* These flags are only present in the quota defaults index entry,
  2070.        i.e. in the entry where owner_id = QUOTA_DEFAULTS_ID. */
  2071.     QUOTA_FLAG_TRACKING_ENABLED    = const_cpu_to_le32(0x00000010),
  2072.     QUOTA_FLAG_ENFORCEMENT_ENABLED    = const_cpu_to_le32(0x00000020),
  2073.     QUOTA_FLAG_TRACKING_REQUESTED    = const_cpu_to_le32(0x00000040),
  2074.     QUOTA_FLAG_LOG_THRESHOLD    = const_cpu_to_le32(0x00000080),
  2075.     QUOTA_FLAG_LOG_LIMIT        = const_cpu_to_le32(0x00000100),
  2076.     QUOTA_FLAG_OUT_OF_DATE        = const_cpu_to_le32(0x00000200),
  2077.     QUOTA_FLAG_CORRUPT        = const_cpu_to_le32(0x00000400),
  2078.     QUOTA_FLAG_PENDING_DELETES    = const_cpu_to_le32(0x00000800),
  2079. } QUOTA_FLAGS;
  2080.  
  2081. /*
  2082.  * The system file FILE_Extend/$Quota contains two indexes $O and $Q. Quotas
  2083.  * are on a per volume and per user basis.
  2084.  *
  2085.  * The $Q index contains one entry for each existing user_id on the volume. The
  2086.  * index key is the user_id of the user/group owning this quota control entry,
  2087.  * i.e. the key is the owner_id. The user_id of the owner of a file, i.e. the
  2088.  * owner_id, is found in the standard information attribute. The collation rule
  2089.  * for $Q is COLLATION_NTOFS_ULONG.
  2090.  *
  2091.  * The $O index contains one entry for each user/group who has been assigned
  2092.  * a quota on that volume. The index key holds the SID of the user_id the
  2093.  * entry belongs to, i.e. the owner_id. The collation rule for $O is
  2094.  * COLLATION_NTOFS_SID.
  2095.  *
  2096.  * The $O index entry data is the user_id of the user corresponding to the SID.
  2097.  * This user_id is used as an index into $Q to find the quota control entry
  2098.  * associated with the SID.
  2099.  *
  2100.  * The $Q index entry data is the quota control entry and is defined below.
  2101.  */
  2102. typedef struct {
  2103.     u32 version;        /* Currently equals 2. */
  2104.     QUOTA_FLAGS flags;    /* Flags describing this quota entry. */
  2105.     u64 bytes_used;        /* How many bytes of the quota are in use. */
  2106.     s64 change_time;    /* Last time this quota entry was changed. */
  2107.     s64 threshold;        /* Soft quota (-1 if not limited). */
  2108.     s64 limit;        /* Hard quota (-1 if not limited). */
  2109.     s64 exceeded_time;    /* How long the soft quota has been exceeded. */
  2110.     SID sid;        /* The SID of the user/object associated with
  2111.                    this quota entry. Equals zero for the quota
  2112.                    defaults entry. */
  2113. } __attribute__ ((__packed__)) QUOTA_CONTROL_ENTRY;
  2114.  
  2115. /*
  2116.  * Predefined owner_id values (32-bit).
  2117.  */
  2118. typedef enum {
  2119.     QUOTA_INVALID_ID    = const_cpu_to_le32(0x00000000),
  2120.     QUOTA_DEFAULTS_ID    = const_cpu_to_le32(0x00000001),
  2121.     QUOTA_FIRST_USER_ID    = const_cpu_to_le32(0x00000100),
  2122. } PREDEFINED_OWNER_IDS;
  2123.  
  2124. /*
  2125.  * Index entry flags (16-bit).
  2126.  */
  2127. typedef enum {
  2128.     INDEX_ENTRY_NODE = const_cpu_to_le16(1), /* This entry contains a
  2129.                     sub-node, i.e. a reference to an index
  2130.                     block in form of a virtual cluster
  2131.                     number (see below). */
  2132.     INDEX_ENTRY_END  = const_cpu_to_le16(2), /* This signifies the last
  2133.                     entry in an index block. The index
  2134.                     entry does not represent a file but it
  2135.                     can point to a sub-node. */
  2136.     INDEX_ENTRY_SPACE_FILLER = 0xffff, /* Just to force 16-bit width. */
  2137. } __attribute__ ((__packed__)) INDEX_ENTRY_FLAGS;
  2138.  
  2139. /*
  2140.  * This the index entry header (see below).
  2141.  */
  2142. typedef struct {
  2143. /*  0*/    union {        /* Only valid when INDEX_ENTRY_END is not set. */
  2144.         MFT_REF indexed_file;        /* The mft reference of the file
  2145.                            described by this index
  2146.                            entry. Used for directory
  2147.                            indexes. */
  2148.         struct { /* Used for views/indexes to find the entry's data. */
  2149.             u16 data_offset;    /* Data byte offset from this
  2150.                            INDEX_ENTRY. Follows the
  2151.                            index key. */
  2152.             u16 data_length;    /* Data length in bytes. */
  2153.             u32 reservedV;    /* Reserved (zero). */
  2154.         } __attribute__ ((__packed__));
  2155.     } __attribute__ ((__packed__));
  2156. /*  8*/    u16 length;         /* Byte size of this index entry, multiple of
  2157.                     8-bytes. */
  2158. /* 10*/    u16 key_length;         /* Byte size of the key value, which is in the
  2159.                     index entry. It follows field reserved. Not
  2160.                     multiple of 8-bytes. */
  2161. /* 12*/    INDEX_ENTRY_FLAGS flags; /* Bit field of INDEX_ENTRY_* flags. */
  2162. /* 14*/    u16 reserved;         /* Reserved/align to 8-byte boundary. */
  2163. /* sizeof() = 16 bytes */
  2164. } __attribute__ ((__packed__)) INDEX_ENTRY_HEADER;
  2165.  
  2166. /*
  2167.  * This is an index entry. A sequence of such entries follows each INDEX_HEADER
  2168.  * structure. Together they make up a complete index. The index follows either
  2169.  * an index root attribute or an index allocation attribute.
  2170.  *
  2171.  * NOTE: Before NTFS 3.0 only filename attributes were indexed.
  2172.  */
  2173. typedef struct {
  2174. /*  0    INDEX_ENTRY_HEADER; -- Unfolded here as gcc dislikes unnamed structs. */
  2175.     union {        /* Only valid when INDEX_ENTRY_END is not set. */
  2176.         MFT_REF indexed_file;        /* The mft reference of the file
  2177.                            described by this index
  2178.                            entry. Used for directory
  2179.                            indexes. */
  2180.         struct { /* Used for views/indexes to find the entry's data. */
  2181.             u16 data_offset;    /* Data byte offset from this
  2182.                            INDEX_ENTRY. Follows the
  2183.                            index key. */
  2184.             u16 data_length;    /* Data length in bytes. */
  2185.             u32 reservedV;        /* Reserved (zero). */
  2186.         } __attribute__ ((__packed__));
  2187.     } __attribute__ ((__packed__));
  2188.     u16 length;         /* Byte size of this index entry, multiple of
  2189.                     8-bytes. */
  2190.     u16 key_length;         /* Byte size of the key value, which is in the
  2191.                     index entry. It follows field reserved. Not
  2192.                     multiple of 8-bytes. */
  2193.     INDEX_ENTRY_FLAGS flags; /* Bit field of INDEX_ENTRY_* flags. */
  2194.     u16 reserved;         /* Reserved/align to 8-byte boundary. */
  2195.  
  2196. /* 16*/    union {        /* The key of the indexed attribute. NOTE: Only present
  2197.                if INDEX_ENTRY_END bit in flags is not set. NOTE: On
  2198.                NTFS versions before 3.0 the only valid key is the
  2199.                FILE_NAME_ATTR. On NTFS 3.0+ the following
  2200.                additional index keys are defined: */
  2201.         FILE_NAME_ATTR file_name;/* $I30 index in directories. */
  2202.         SII_INDEX_KEY sii;    /* $SII index in $Secure. */
  2203.         SDH_INDEX_KEY sdh;    /* $SDH index in $Secure. */
  2204.         GUID object_id;        /* $O index in FILE_Extend/$ObjId: The
  2205.                        object_id of the mft record found in
  2206.                        the data part of the index. */
  2207.         REPARSE_INDEX_KEY reparse;    /* $R index in
  2208.                            FILE_Extend/$Reparse. */
  2209.         SID sid;        /* $O index in FILE_Extend/$Quota:
  2210.                        SID of the owner of the user_id. */
  2211.         u32 owner_id;        /* $Q index in FILE_Extend/$Quota:
  2212.                        user_id of the owner of the quota
  2213.                        control entry in the data part of
  2214.                        the index. */
  2215.     } __attribute__ ((__packed__)) key;
  2216.     /* The (optional) index data is inserted here when creating. */
  2217.     // VCN vcn;    /* If INDEX_ENTRY_NODE bit in flags is set, the last
  2218.     //           eight bytes of this index entry contain the virtual
  2219.     //           cluster number of the index block that holds the
  2220.     //           entries immediately preceding the current entry (the
  2221.     //           vcn references the corresponding cluster in the data
  2222.     //           of the non-resident index allocation attribute). If
  2223.     //           the key_length is zero, then the vcn immediately
  2224.     //           follows the INDEX_ENTRY_HEADER. Regardless of
  2225.     //           key_length, the address of the 8-byte boundary
  2226.     //           aligned vcn of INDEX_ENTRY{_HEADER} *ie is given by
  2227.     //           (char*)ie + le16_to_cpu(ie->length) - sizeof(VCN),
  2228.     //           where sizeof(VCN) can be hardcoded as 8 if wanted. */
  2229. } __attribute__ ((__packed__)) INDEX_ENTRY;
  2230.  
  2231. /*
  2232.  * Attribute: Bitmap (0xb0).
  2233.  *
  2234.  * Contains an array of bits (aka a bitfield).
  2235.  *
  2236.  * When used in conjunction with the index allocation attribute, each bit
  2237.  * corresponds to one index block within the index allocation attribute. Thus
  2238.  * the number of bits in the bitmap * index block size / cluster size is the
  2239.  * number of clusters in the index allocation attribute.
  2240.  */
  2241. typedef struct {
  2242.     u8 bitmap[0];            /* Array of bits. */
  2243. } __attribute__ ((__packed__)) BITMAP_ATTR;
  2244.  
  2245. /*
  2246.  * The reparse point tag defines the type of the reparse point. It also
  2247.  * includes several flags, which further describe the reparse point.
  2248.  *
  2249.  * The reparse point tag is an unsigned 32-bit value divided in three parts:
  2250.  *
  2251.  * 1. The least significant 16 bits (i.e. bits 0 to 15) specify the type of
  2252.  *    the reparse point.
  2253.  * 2. The 13 bits after this (i.e. bits 16 to 28) are reserved for future use.
  2254.  * 3. The most significant three bits are flags describing the reparse point.
  2255.  *    They are defined as follows:
  2256.  *    bit 29: Name surrogate bit. If set, the filename is an alias for
  2257.  *        another object in the system.
  2258.  *    bit 30: High-latency bit. If set, accessing the first byte of data will
  2259.  *        be slow. (E.g. the data is stored on a tape drive.)
  2260.  *    bit 31: Microsoft bit. If set, the tag is owned by Microsoft. User
  2261.  *        defined tags have to use zero here.
  2262.  */
  2263. typedef enum {
  2264.     IO_REPARSE_TAG_IS_ALIAS        = const_cpu_to_le32(0x20000000),
  2265.     IO_REPARSE_TAG_IS_HIGH_LATENCY    = const_cpu_to_le32(0x40000000),
  2266.     IO_REPARSE_TAG_IS_MICROSOFT    = const_cpu_to_le32(0x80000000),
  2267.  
  2268.     IO_REPARSE_TAG_RESERVED_ZERO    = const_cpu_to_le32(0x00000000),
  2269.     IO_REPARSE_TAG_RESERVED_ONE    = const_cpu_to_le32(0x00000001),
  2270.     IO_REPARSE_TAG_RESERVED_RANGE    = const_cpu_to_le32(0x00000001),
  2271.  
  2272.     IO_REPARSE_TAG_NSS        = const_cpu_to_le32(0x68000005),
  2273.     IO_REPARSE_TAG_NSS_RECOVER    = const_cpu_to_le32(0x68000006),
  2274.     IO_REPARSE_TAG_SIS        = const_cpu_to_le32(0x68000007),
  2275.     IO_REPARSE_TAG_DFS        = const_cpu_to_le32(0x68000008),
  2276.  
  2277.     IO_REPARSE_TAG_MOUNT_POINT    = const_cpu_to_le32(0x88000003),
  2278.  
  2279.     IO_REPARSE_TAG_HSM        = const_cpu_to_le32(0xa8000004),
  2280.  
  2281.     IO_REPARSE_TAG_SYMBOLIC_LINK    = const_cpu_to_le32(0xe8000000),
  2282.  
  2283.     IO_REPARSE_TAG_VALID_VALUES    = const_cpu_to_le32(0xe000ffff),
  2284. } PREDEFINED_REPARSE_TAGS;
  2285.  
  2286. /*
  2287.  * Attribute: Reparse point (0xc0).
  2288.  *
  2289.  * NOTE: Can be resident or non-resident.
  2290.  */
  2291. typedef struct {
  2292.     u32 reparse_tag;        /* Reparse point type (inc. flags). */
  2293.     u16 reparse_data_length;    /* Byte size of reparse data. */
  2294.     u16 reserved;            /* Align to 8-byte boundary. */
  2295.     u8 reparse_data[0];        /* Meaning depends on reparse_tag. */
  2296. } __attribute__ ((__packed__)) REPARSE_POINT;
  2297.  
  2298. /*
  2299.  * Attribute: Extended attribute (EA) information (0xd0).
  2300.  *
  2301.  * NOTE: Always resident.
  2302.  */
  2303. typedef struct {
  2304.     u16 ea_length;        /* Byte size of the packed extended
  2305.                    attributes. */
  2306.     u16 need_ea_count;    /* The number of extended attributes which have
  2307.                    the NEED_EA bit set. */
  2308.     u32 ea_query_length;    /* Byte size of the buffer required to query
  2309.                    the extended attributes when calling
  2310.                    ZwQueryEaFile() in Windows NT/2k. I.e. the
  2311.                    byte size of the unpacked extended
  2312.                    attributes. */
  2313. } __attribute__ ((__packed__)) EA_INFORMATION;
  2314.  
  2315. /*
  2316.  * Extended attribute flags (8-bit).
  2317.  */
  2318. typedef enum {
  2319.     NEED_EA    = 0x80,
  2320. } __attribute__ ((__packed__)) EA_FLAGS;
  2321.  
  2322. /*
  2323.  * Attribute: Extended attribute (EA) (0xe0).
  2324.  *
  2325.  * Like the attribute list and the index buffer list, the EA attribute value is
  2326.  * a sequence of EA_ATTR variable length records.
  2327.  *
  2328.  * FIXME: It appears weird that the EA name is not Unicode. Is it true?
  2329.  * FIXME: It seems that name is always uppercased. Is it true?
  2330.  */
  2331. typedef struct {
  2332.     u32 next_entry_offset;    /* Offset to the next EA_ATTR. */
  2333.     EA_FLAGS flags;        /* Flags describing the EA. */
  2334.     u8 name_length;        /* Length of the name of the extended
  2335.                    attribute in bytes. */
  2336.     u16 value_length;    /* Byte size of the EA's value. */
  2337.     u8 name[0];        /* Name of the EA. */
  2338.     u8 value[0];        /* The value of the EA. Immediately
  2339.                    follows the name. */
  2340. } __attribute__ ((__packed__)) EA_ATTR;
  2341.  
  2342. /*
  2343.  * Attribute: Property set (0xf0).
  2344.  *
  2345.  * Intended to support Native Structure Storage (NSS) - a feature removed from
  2346.  * NTFS 3.0 during beta testing.
  2347.  */
  2348. typedef struct {
  2349.     /* Irrelevant as feature unused. */
  2350. } __attribute__ ((__packed__)) PROPERTY_SET;
  2351.  
  2352. /*
  2353.  * Attribute: Logged utility stream (0x100).
  2354.  *
  2355.  * NOTE: Can be resident or non-resident.
  2356.  *
  2357.  * Operations on this attribute are logged to the journal ($LogFile) like
  2358.  * normal metadata changes.
  2359.  *
  2360.  * Used by the Encrypting File System (EFS).  All encrypted files have this
  2361.  * attribute with the name $EFS.  See below for the relevant structures.
  2362.  */
  2363. typedef struct {
  2364.     /* Can be anything the creator chooses. */
  2365. } __attribute__ ((__packed__)) LOGGED_UTILITY_STREAM;
  2366.  
  2367. /*
  2368.  * $EFS Data Structure:
  2369.  *
  2370.  * The following information is about the data structures that are contained
  2371.  * inside a logged utility stream (0x100) with a name of "$EFS".
  2372.  *
  2373.  * The stream starts with an instance of EFS_ATTR_HEADER.
  2374.  *
  2375.  * Next, at offsets offset_to_ddf_array and offset_to_drf_array (unless any of
  2376.  * them is 0) there is a EFS_DF_ARRAY_HEADER immediately followed by a sequence
  2377.  * of multiple data decryption/recovery fields.
  2378.  *
  2379.  * Each data decryption/recovery field starts with a EFS_DF_HEADER and the next
  2380.  * one (if it exists) can be found by adding EFS_DF_HEADER->df_length bytes to
  2381.  * the offset of the beginning of the current EFS_DF_HEADER.
  2382.  *
  2383.  * The data decryption/recovery field contains an EFS_DF_CERTIFICATE_HEADER, a
  2384.  * SID, an optional GUID, an optional container name, a non-optional user name,
  2385.  * and the encrypted FEK.
  2386.  *
  2387.  * Note all the below are best guesses so may have mistakes/inaccuracies.
  2388.  * Corrections/clarifications/additions are always welcome!
  2389.  */
  2390.  
  2391. /* The header of the 0x100 attribute named "$EFS". */
  2392. typedef struct {
  2393. /*  0*/    u32 length;        /* Length of EFS attribute in bytes. */
  2394.     u32 state;        /* Always 0? */
  2395.     u32 version;        /* Efs version.  Always 2? */
  2396.     u32 crypto_api_version;    /* Always 0? */
  2397. /* 16*/    u8 unknown4[16];    /* MD5 hash of decrypted FEK? */
  2398. /* 32*/    u8 unknown5[16];    /* MD5 hash of DDFs? */
  2399. /* 48*/    u8 unknown6[16];    /* MD5 hash of DRFs? */
  2400. /* 64*/    u32 offset_to_ddf_array;/* Offset in bytes to the array of data
  2401.                    decryption fields (DDF), see below.  Zero if
  2402.                    no DDFs are present. */
  2403.     u32 offset_to_drf_array;/* Offset in bytes to the array of data
  2404.                    recovery fields (DRF), see below.  Zero if
  2405.                    no DRFs are present. */
  2406.     u32 reserved;        /* Reserved. */
  2407. } __attribute__ ((__packed__)) EFS_ATTR_HEADER;
  2408.  
  2409. typedef struct {
  2410.     u32 df_count;        /* Number of data decryption/recovery fields in
  2411.                    the array. */
  2412. } __attribute__ ((__packed__)) EFS_DF_ARRAY_HEADER;
  2413.  
  2414. typedef struct {
  2415. /*  0*/    u32 df_length;        /* Length of this data decryption/recovery
  2416.                    field in bytes. */
  2417.     u32 cred_header_offset;    /* Offset in bytes to the credential header. */
  2418.     u32 fek_size;        /* Size in bytes of the encrypted file
  2419.                    encryption key (FEK). */
  2420.     u32 fek_offset;        /* Offset in bytes to the FEK from the start of
  2421.                    the data decryption/recovery field. */
  2422. /* 16*/    u32 unknown1;        /* always 0?  Might be just padding. */
  2423. } __attribute__ ((__packed__)) EFS_DF_HEADER;
  2424.  
  2425. typedef struct {
  2426. /*  0*/    u32 cred_length;    /* Length of this credential in bytes. */
  2427.     u32 sid_offset;        /* Offset in bytes to the user's sid from start
  2428.                    of this structure.  Zero if no sid is
  2429.                    present. */
  2430. /*  8*/    u32 type;        /* Type of this credential:
  2431.                     1 = CryptoAPI container.
  2432.                     2 = Unexpected type.
  2433.                     3 = Certificate thumbprint.
  2434.                     other = Unknown type. */
  2435.         union {
  2436.         /* CryptoAPI container. */
  2437.         struct {
  2438. /* 12*/            u32 container_name_offset;    /* Offset in bytes to
  2439.                    the name of the container from start of this
  2440.                    structure (may not be zero). */
  2441. /* 16*/            u32 provider_name_offset;    /* Offset in bytes to
  2442.                    the name of the provider from start of this
  2443.                    structure (may not be zero). */
  2444.             u32 public_key_blob_offset;    /* Offset in bytes to
  2445.                    the public key blob from start of this
  2446.                    structure. */
  2447. /* 24*/            u32 public_key_blob_size;    /* Size in bytes of
  2448.                    public key blob. */
  2449.         } __attribute__ ((__packed__));
  2450.         /* Certificate thumbprint. */
  2451.         struct {
  2452. /* 12*/            u32 cert_thumbprint_header_size;    /* Size in
  2453.                    bytes of the header of the certificate
  2454.                    thumbprint. */
  2455. /* 16*/            u32 cert_thumbprint_header_offset;    /* Offset in
  2456.                    bytes to the header of the certificate
  2457.                    thumbprint from start of this structure. */
  2458.             u32 unknown1;    /* Always 0?  Might be padding... */
  2459.             u32 unknown2;    /* Always 0?  Might be padding... */
  2460.         } __attribute__ ((__packed__));
  2461.     } __attribute__ ((__packed__));
  2462. } __attribute__ ((__packed__)) EFS_DF_CREDENTIAL_HEADER;
  2463.  
  2464. typedef EFS_DF_CREDENTIAL_HEADER EFS_DF_CRED_HEADER;
  2465.  
  2466. typedef struct {
  2467. /*  0*/    u32 thumbprint_offset;        /* Offset in bytes to the thumbprint. */
  2468.     u32 thumbprint_size;        /* Size of thumbprint in bytes. */
  2469. /*  8*/    u32 container_name_offset;    /* Offset in bytes to the name of the
  2470.                        container from start of this
  2471.                        structure or 0 if no name present. */
  2472.     u32 provider_name_offset;    /* Offset in bytes to the name of the
  2473.                        cryptographic provider from start of
  2474.                        this structure or 0 if no name
  2475.                        present. */
  2476. /* 16*/    u32 user_name_offset;        /* Offset in bytes to the user name
  2477.                        from start of this structure or 0 if
  2478.                        no user name present.  (This is also
  2479.                        known as lpDisplayInformation.) */
  2480. } __attribute__ ((__packed__)) EFS_DF_CERTIFICATE_THUMBPRINT_HEADER;
  2481.  
  2482. typedef EFS_DF_CERTIFICATE_THUMBPRINT_HEADER EFS_DF_CERT_THUMBPRINT_HEADER;
  2483.     
  2484. #endif /* defined _NTFS_LAYOUT_H */
  2485.